Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Issue 28587: list.index documentation missing start and stop arguments. (Contributed by Mariatta Wijaya.)

This commit is contained in:
Raymond Hettinger 2016-11-21 15:12:54 -08:00
parent 5cb0c09fa6
commit 5bd5b9d813
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/tutorial/datastructures.rst
View File

@ -60,11 +60,16 @@ objects:
Remove all items from the list. Equivalent to ``del a[:]``.
.. method:: list.index(x)
.. method:: list.index(x[, start[, end]])
:noindex:
Return the index in the list of the first item whose value is *x*. It is an
error if there is no such item.
Return zero-based index in the list of the first item whose value is *x*.
Raises a :exc:`ValueError` if there is no such item.
The optional arguments *start* and *end* are interpreted as in the slice
notation and are used to limit the search to a particular subsequence of
*x*. The returned index is computed relative to the beginning of the full
sequence rather than the *start* argument.
.. method:: list.count(x)
@ -103,6 +108,8 @@ An example that uses most of the list methods::
[66.25, 333, -1, 333, 1, 1234.5, 333]
>>> a.index(333)
1
>>> a.index(333, 2) # search for 333 starting at index 2
2
>>> a.remove(333)
>>> a
[66.25, -1, 333, 1, 1234.5, 333]