From: Joshua Bronson <jabronson@gmail.com>
Date: Wed, 19 Jan 2022 21:20:43 +0000 (-0500)
Subject: docs: correct outdated MappingProxyType docstrings (#30281)
X-Git-Tag: v3.11.0a5~204
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2d10fa9bc4cf83c5e5dd73decc9a138d6d247374;p=thirdparty%2FPython%2Fcpython.git

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.
---

diff --git a/Objects/descrobject.c b/Objects/descrobject.c
index 946ea6aa8031..962136beae05 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,