This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Missing (optional) argument `start` and `end` in documentation for list.index
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: not a bug
Dependencies: Superseder:
Assigned To: docs@python Nosy List: SylvainDe, docs@python, ezio.melotti, r.david.murray
Priority: normal Keywords: patch

Created on 2014-07-16 12:40 by SylvainDe, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
list_index_start_end.patch SylvainDe, 2014-07-16 12:40 Simple patch to document the function signature review
Messages (2)
msg223195 - (view) Author: SylvainDe (SylvainDe) * Date: 2014-07-16 12:40
From :

https://docs.python.org/2/tutorial/datastructures.html and
https://docs.python.org/3.4/tutorial/datastructures.html (and all other versions) :

----------------------------
    list.index(x)

        Return the index in the list of the first item whose value is x. It is an error if there is no such item.
----------------------------

From `help(list)` :

----------------------------
 |  index(...)
 |      L.index(value, [start, [stop]]) -> integer -- return first index of value.
 |      Raises ValueError if the value is not present.
----------------------------

Thus, second and third parameter are undocumented.
msg223434 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-07-18 21:03
It's a tutorial, not API documentation.  You will note that the 'key' and 'reverse' arguments to sort are not mentioned either.
History
Date User Action Args
2022-04-11 14:58:06adminsetgithub: 66188
2021-04-02 16:22:47iritkatrielunlinkissue33757 superseder
2021-04-02 16:21:00iritkatriellinkissue33757 superseder
2014-07-18 21:03:36r.david.murraysetstatus: open -> closed

nosy: + r.david.murray
messages: + msg223434

resolution: not a bug
stage: resolved
2014-07-16 16:09:25berker.peksagsetnosy: + ezio.melotti

versions: - Python 3.1, Python 3.2, Python 3.3
2014-07-16 12:40:19SylvainDecreate