New submission from Raymond Hettinger:
The docstring for str.index() needs to be synced with the main documentation
rather than presuming knowledge of str.find().
Currently it reads:
>>> help(str.index)
Help on method_descriptor:
index(...)
S.index(sub[, start[, end]]) -> int
Like S.find() but raise ValueError when the substring is not found.
And it should read more like str.find:
help(str.find)
Help on method_descriptor:
find(...)
S.find(sub[, start[, end]]) -> int
Return the lowest index in S where substring sub is found,
such that sub is contained within S[start:end]. Optional
arguments start and end are interpreted as in slice notation.
Return -1 on failure.
Lisa, it would be great if you could draft-up a patch.
----------
assignee: lisroach
components: Documentation
messages: 287724
nosy: lisroach, rhettinger
priority: normal
severity: normal
stage: needs patch
status: open
title: Improve docstring for str.index
versions: Python 2.7, Python 3.6, Python 3.7
_______________________________________
Python tracker <[email protected]>
<http://bugs.python.org/issue29549>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
