diff options
| author | Joshua Bronson <jabronson@gmail.com> | 2022-01-19 21:20:43 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-19 21:20:43 (GMT) |
| commit | 2d10fa9bc4cf83c5e5dd73decc9a138d6d247374 (patch) | |
| tree | 148ba434cfc430c93ca9cf60dc2853872369883c /Objects | |
| parent | d45cd2d20770f72a000ba6dfa9ac88dd49423c27 (diff) | |
| download | cpython-2d10fa9bc4cf83c5e5dd73decc9a138d6d247374.zip cpython-2d10fa9bc4cf83c5e5dd73decc9a138d6d247374.tar.gz cpython-2d10fa9bc4cf83c5e5dd73decc9a138d6d247374.tar.bz2 | |
docs: correct outdated MappingProxyType docstrings (#30281)
The docstrings for MappingProxyType's keys(), values(), and items()
methods were never updated to reflect the changes that Python 3 brought
to these APIs, namely returning views rather than lists.
Diffstat (limited to 'Objects')
| -rw-r--r-- | Objects/descrobject.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Objects/descrobject.c b/Objects/descrobject.c index 946ea6a..962136b 100644 --- a/Objects/descrobject.c +++ b/Objects/descrobject.c @@ -1135,11 +1135,11 @@ static PyMethodDef mappingproxy_methods[] = { PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d." " d defaults to None.")}, {"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS, - PyDoc_STR("D.keys() -> list of D's keys")}, + PyDoc_STR("D.keys() -> a set-like object providing a view on D's keys")}, {"values", (PyCFunction)mappingproxy_values, METH_NOARGS, - PyDoc_STR("D.values() -> list of D's values")}, + PyDoc_STR("D.values() -> an object providing a view on D's values")}, {"items", (PyCFunction)mappingproxy_items, METH_NOARGS, - PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")}, + PyDoc_STR("D.items() -> a set-like object providing a view on D's items")}, {"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS, PyDoc_STR("D.copy() -> a shallow copy of D")}, {"__class_getitem__", Py_GenericAlias, METH_O|METH_CLASS, |