Skip to content

Commit 2d10fa9

Browse files
authored
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.
1 parent d45cd2d commit 2d10fa9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Objects/descrobject.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,11 +1135,11 @@ static PyMethodDef mappingproxy_methods[] = {
11351135
PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
11361136
" d defaults to None.")},
11371137
{"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
1138-
PyDoc_STR("D.keys() -> list of D's keys")},
1138+
PyDoc_STR("D.keys() -> a set-like object providing a view on D's keys")},
11391139
{"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
1140-
PyDoc_STR("D.values() -> list of D's values")},
1140+
PyDoc_STR("D.values() -> an object providing a view on D's values")},
11411141
{"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
1142-
PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
1142+
PyDoc_STR("D.items() -> a set-like object providing a view on D's items")},
11431143
{"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
11441144
PyDoc_STR("D.copy() -> a shallow copy of D")},
11451145
{"__class_getitem__", Py_GenericAlias, METH_O|METH_CLASS,

0 commit comments

Comments
 (0)