[Python-checkins] cpython (3.5): Issues #25909, #28211: Restored correct documentation of PyMapping_Items,
serhiy.storchaka
python-checkins at python.org
Mon Sep 26 13:54:48 EDT 2016
https://hg.python.org/cpython/rev/68fc808bed9f
changeset: 104065:68fc808bed9f
branch: 3.5
parent: 104060:216e8b809e4e
user: Serhiy Storchaka <storchaka at gmail.com>
date: Mon Sep 26 20:52:41 2016 +0300
summary:
Issues #25909, #28211: Restored correct documentation of PyMapping_Items,
PyMapping_Keys and PyMapping_Values. Based on patch by Xiang Zhang.
files:
Doc/c-api/mapping.rst | 13 ++++++-------
Include/abstract.h | 14 +++++++-------
2 files changed, 13 insertions(+), 14 deletions(-)
diff --git a/Doc/c-api/mapping.rst b/Doc/c-api/mapping.rst
--- a/Doc/c-api/mapping.rst
+++ b/Doc/c-api/mapping.rst
@@ -50,21 +50,20 @@
.. c:function:: PyObject* PyMapping_Keys(PyObject *o)
- On success, return a list, a tuple or a dictionary view in case of a dict,
- of the keys in object *o*. On failure, return *NULL*.
+ On success, return a list or tuple of the keys in object *o*. On failure,
+ return *NULL*.
.. c:function:: PyObject* PyMapping_Values(PyObject *o)
- On success, return a list, a tuple or a dictionary view in case of a dict, of
- the values in object *o*. On failure, return *NULL*.
+ On success, return a list or tuple of the values in object *o*. On failure,
+ return *NULL*.
.. c:function:: PyObject* PyMapping_Items(PyObject *o)
- On success, return a list, a tuple or a dictionary view in case of a dict, of
- the items in object *o*, where each item is a tuple containing a key-value
- pair. On failure, return *NULL*.
+ On success, return a list or tuple of the items in object *o*, where each item
+ is a tuple containing a key-value pair. On failure, return *NULL*.
.. c:function:: PyObject* PyMapping_GetItemString(PyObject *o, const char *key)
diff --git a/Include/abstract.h b/Include/abstract.h
--- a/Include/abstract.h
+++ b/Include/abstract.h
@@ -1216,23 +1216,23 @@
PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o);
/*
- On success, return a list, a tuple or a dictionary view in case of a dict,
- of the keys in object o. On failure, return NULL.
+ On success, return a list or tuple of the keys in object o.
+ On failure, return NULL.
*/
PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o);
/*
- On success, return a list, a tuple or a dictionary view in case of a dict,
- of the values in object o. On failure, return NULL.
+ On success, return a list or tuple of the values in object o.
+ On failure, return NULL.
*/
PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o);
/*
- On success, return a list, a tuple or a dictionary view in case of a dict,
- of the items in object o, where each item is a tuple containing a key-value
- pair. On failure, return NULL.
+ On success, return a list or tuple of the items in object o,
+ where each item is a tuple containing a key-value pair.
+ On failure, return NULL.
*/
--
Repository URL: https://hg.python.org/cpython
More information about the Python-checkins
mailing list