[Python-checkins] docs: correct outdated MappingProxyType docstrings (GH-30281)

miss-islington webhook-mailer at python.org
Wed Jan 19 16:57:34 EST 2022


https://github.com/python/cpython/commit/54feddae8832f24f1ca8ebd1f21a19d6aec4b3fd
commit: 54feddae8832f24f1ca8ebd1f21a19d6aec4b3fd
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-01-19T13:57:30-08:00
summary:

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 2d10fa9bc4cf83c5e5dd73decc9a138d6d247374)

Co-authored-by: Joshua Bronson <jabronson at gmail.com>

files:
M Objects/descrobject.c

diff --git a/Objects/descrobject.c b/Objects/descrobject.c
index 075a92d4084d5..ee40645955206 100644
--- a/Objects/descrobject.c
+++ b/Objects/descrobject.c
@@ -1134,11 +1134,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__", (PyCFunction)Py_GenericAlias, METH_O|METH_CLASS,



More information about the Python-checkins mailing list