Skip to content

Commit 54fedda

Browse files
miss-islingtonjab
andauthored
docs: correct outdated MappingProxyType docstrings (GH-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. (cherry picked from commit 2d10fa9) Co-authored-by: Joshua Bronson <jabronson@gmail.com>
1 parent 0064516 commit 54fedda

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
@@ -1134,11 +1134,11 @@ static PyMethodDef mappingproxy_methods[] = {
11341134
PyDoc_STR("D.get(k[,d]) -> D[k] if k in D, else d."
11351135
" d defaults to None.")},
11361136
{"keys", (PyCFunction)mappingproxy_keys, METH_NOARGS,
1137-
PyDoc_STR("D.keys() -> list of D's keys")},
1137+
PyDoc_STR("D.keys() -> a set-like object providing a view on D's keys")},
11381138
{"values", (PyCFunction)mappingproxy_values, METH_NOARGS,
1139-
PyDoc_STR("D.values() -> list of D's values")},
1139+
PyDoc_STR("D.values() -> an object providing a view on D's values")},
11401140
{"items", (PyCFunction)mappingproxy_items, METH_NOARGS,
1141-
PyDoc_STR("D.items() -> list of D's (key, value) pairs, as 2-tuples")},
1141+
PyDoc_STR("D.items() -> a set-like object providing a view on D's items")},
11421142
{"copy", (PyCFunction)mappingproxy_copy, METH_NOARGS,
11431143
PyDoc_STR("D.copy() -> a shallow copy of D")},
11441144
{"__class_getitem__", (PyCFunction)Py_GenericAlias, METH_O|METH_CLASS,

0 commit comments

Comments
 (0)