diff options
| author | Georg Brandl <georg@python.org> | 2010-12-01 15:36:33 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-12-01 15:36:33 (GMT) |
| commit | f7f5a82b36064c427c40ea5968eb4a9620912642 (patch) | |
| tree | ea849627a7fae633a998743733017865d6a965cf /Doc/c-api/list.rst | |
| parent | 063f23781282e044c860f873ecbec27318524992 (diff) | |
| download | cpython-f7f5a82b36064c427c40ea5968eb4a9620912642.zip cpython-f7f5a82b36064c427c40ea5968eb4a9620912642.tar.gz cpython-f7f5a82b36064c427c40ea5968eb4a9620912642.tar.bz2 | |
#10594: fix parameter names in PyList API docs.
Diffstat (limited to 'Doc/c-api/list.rst')
| -rw-r--r-- | Doc/c-api/list.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/c-api/list.rst b/Doc/c-api/list.rst index 25a13e9..feb9015 100644 --- a/Doc/c-api/list.rst +++ b/Doc/c-api/list.rst @@ -37,7 +37,7 @@ List Objects .. note:: - If *length* is greater than zero, the returned list object's items are + If *len* is greater than zero, the returned list object's items are set to ``NULL``. Thus you cannot use abstract API functions such as :c:func:`PySequence_SetItem` or expose the object to Python code before setting all items to a real object with :c:func:`PyList_SetItem`. @@ -58,9 +58,9 @@ List Objects .. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index) - Return the object at position *pos* in the list pointed to by *p*. The + Return the object at position *index* in the list pointed to by *list*. The position must be positive, indexing from the end of the list is not - supported. If *pos* is out of bounds, return *NULL* and set an + supported. If *index* is out of bounds, return *NULL* and set an :exc:`IndexError` exception. |