summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/list.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/list.rst')
-rw-r--r--Doc/c-api/list.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/Doc/c-api/list.rst b/Doc/c-api/list.rst
index c8b64ba..53eb54d 100644
--- a/Doc/c-api/list.rst
+++ b/Doc/c-api/list.rst
@@ -56,13 +56,21 @@ List Objects
Similar to :c:func:`PyList_Size`, but without error checking.
-.. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index)
+.. c:function:: PyObject* PyList_GetItemRef(PyObject *list, Py_ssize_t index)
Return the object at position *index* in the list pointed to by *list*. The
position must be non-negative; indexing from the end of the list is not
- supported. If *index* is out of bounds (<0 or >=len(list)),
+ supported. If *index* is out of bounds (:code:`<0 or >=len(list)`),
return ``NULL`` and set an :exc:`IndexError` exception.
+ .. versionadded:: 3.13
+
+
+.. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index)
+
+ Like :c:func:`PyList_GetItemRef`, but returns a
+ :term:`borrowed reference` instead of a :term:`strong reference`.
+
.. c:function:: PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i)