From 1d480bea9c951af9c317b699c4a420990f401918 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Mon, 26 Sep 2016 20:52:41 +0300 Subject: [PATCH] Issues #25909, #28211: Restored correct documentation of PyMapping_Items, PyMapping_Keys and PyMapping_Values. Based on patch by Xiang Zhang. --- 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 index fe601b605b1..a71e9428377 100644 --- a/Doc/c-api/mapping.rst +++ b/Doc/c-api/mapping.rst @@ -50,21 +50,20 @@ Mapping Protocol .. 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 index 438610ba985..36df5a7ce2a 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -1216,23 +1216,23 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ 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. */