summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsrinivasan <shivnaren@gmail.com>2024-02-01 03:46:49 (GMT)
committerGitHub <noreply@github.com>2024-02-01 03:46:49 (GMT)
commit57c3e775df5a5ca0982adf15010ed80a158b1b80 (patch)
tree4e62850853b9b7686020d0708b90fb06005ea79d
parent586057e9f80d57f16334c0eee8431931e4aa8cff (diff)
downloadcpython-57c3e775df5a5ca0982adf15010ed80a158b1b80.zip
cpython-57c3e775df5a5ca0982adf15010ed80a158b1b80.tar.gz
cpython-57c3e775df5a5ca0982adf15010ed80a158b1b80.tar.bz2
gh-114648: Add IndexError exception to tutorial datastructures list.pop entry (#114681)
Remove redundant explanation of optional argument.
-rw-r--r--Doc/tutorial/datastructures.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/tutorial/datastructures.rst b/Doc/tutorial/datastructures.rst
index 87614d0..de28274 100644
--- a/Doc/tutorial/datastructures.rst
+++ b/Doc/tutorial/datastructures.rst
@@ -48,10 +48,9 @@ objects:
:noindex:
Remove the item at the given position in the list, and return it. If no index
- is specified, ``a.pop()`` removes and returns the last item in the list. (The
- square brackets around the *i* in the method signature denote that the parameter
- is optional, not that you should type square brackets at that position. You
- will see this notation frequently in the Python Library Reference.)
+ is specified, ``a.pop()`` removes and returns the last item in the list.
+ It raises an :exc:`IndexError` if the list is empty or the index is
+ outside the list range.
.. method:: list.clear()