[docs] list.index documentation missing start and stop arguments (issue 28587)

chrisrands0 at gmail.com chrisrands0 at gmail.com
Wed Nov 2 09:28:21 EDT 2016


Reviewers: ,

Message:
Thanks to Mariatta for the patch, which addresses the issue, so I think
it can be applied to the Python 3 and 2 documentation. One point, I do
not know when the start and stop arguments were added to list.count (or
if they always existed). I have only tested them in Python2.7 and
Python3.5.



Please review this at http://bugs.python.org/review/28587/

Affected files:
  Doc/tutorial/datastructures.rst


diff -r 0c8ffa562f3a Doc/tutorial/datastructures.rst
--- a/Doc/tutorial/datastructures.rst	Wed Nov 02 12:13:48 2016 +0200
+++ b/Doc/tutorial/datastructures.rst	Wed Nov 02 06:04:14 2016 -0700
@@ -60,11 +60,12 @@
    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.
+   error if there is no such item.  Optional arguments ``start`` and ``end``
+   are interpreted as in slice notation.
 
 
 .. method:: list.count(x)
@@ -101,8 +102,8 @@
    >>> a.append(333)
    >>> a
    [66.25, 333, -1, 333, 1, 1234.5, 333]
-   >>> a.index(333)
-   1
+   >>> a.index(333, 2)
+   3
    >>> a.remove(333)
    >>> a
    [66.25, -1, 333, 1, 1234.5, 333]




More information about the docs mailing list