summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2015-03-13 00:56:12 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2015-03-13 00:56:12 (GMT)
commit09bb904fda1df8556b3925a960cd9e9311dca5cc (patch)
treec43d2ac7b97840bd93927a7394cbfb0705f96df8
parent406221ccd9048f48ba259cd545d69c3f7db08784 (diff)
parent32799953b0bf2cf069c90f8ecc57b1b1d41b7ce8 (diff)
downloadcpython-09bb904fda1df8556b3925a960cd9e9311dca5cc.zip
cpython-09bb904fda1df8556b3925a960cd9e9311dca5cc.tar.gz
cpython-09bb904fda1df8556b3925a960cd9e9311dca5cc.tar.bz2
Issue #23081: Document that PySequence_List also accepts iterables.
Patch by Lars Buitinck.
-rw-r--r--Doc/c-api/sequence.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/c-api/sequence.rst b/Doc/c-api/sequence.rst
index cf1e142..5960db9 100644
--- a/Doc/c-api/sequence.rst
+++ b/Doc/c-api/sequence.rst
@@ -107,8 +107,9 @@ Sequence Protocol
.. c:function:: PyObject* PySequence_List(PyObject *o)
- Return a list object with the same contents as the arbitrary sequence *o*. The
- returned list is guaranteed to be new.
+ Return a list object with the same contents as the sequence or iterable *o*,
+ or *NULL* on failure. The returned list is guaranteed to be new. This is
+ equivalent to the Python expression ``list(o)``.
.. c:function:: PyObject* PySequence_Tuple(PyObject *o)