From f8709e804d16ec5d44b1d2f00d59a0f78df7b792 Mon Sep 17 00:00:00 2001
From: Terry Jan Reedy <tjreedy@udel.edu>
Date: Sat, 6 Jul 2019 17:40:27 -0400
Subject: [PATCH] bpo-37487: Fix PyList_GetItem index description. (GH-14623)
0 is a legal index.
---
Doc/c-api/list.rst | 6 +++---
.../Documentation/2019-07-06-17-19-26.bpo-37487.QagfZ5.rst | 1 +
2 files changed, 4 insertions(+), 3 deletions(-)
create mode 100644 Misc/NEWS.d/next/Documentation/2019-07-06-17-19-26.bpo-37487.QagfZ5.rst
diff --git a/Doc/c-api/list.rst b/Doc/c-api/list.rst
index 279783a243..dc9026605b 100644
--- a/Doc/c-api/list.rst
+++ b/Doc/c-api/list.rst
@@ -59,9 +59,9 @@ List Objects
.. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index)
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 *index* is out of bounds, return *NULL* and set an
- :exc:`IndexError` exception.
+ 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)),
+ return *NULL* and set an :exc:`IndexError` exception.
.. c:function:: PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i)
diff --git a/Misc/NEWS.d/next/Documentation/2019-07-06-17-19-26.bpo-37487.QagfZ5.rst b/Misc/NEWS.d/next/Documentation/2019-07-06-17-19-26.bpo-37487.QagfZ5.rst
new file mode 100644
index 0000000000..605d08c3c0
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2019-07-06-17-19-26.bpo-37487.QagfZ5.rst
@@ -0,0 +1 @@
+Fix PyList_GetItem index description to include 0.
--
2.49.0