Author rhettinger
Recipients lisroach, rhettinger
Date 2017-02-13.20:57:22
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1487019442.21.0.885918615749.issue29549@psf.upfronthosting.co.za>
In-reply-to
Content
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.
History
Date User Action Args
2017-02-13 20:57:22rhettingersetrecipients: + rhettinger, lisroach
2017-02-13 20:57:22rhettingersetmessageid: <1487019442.21.0.885918615749.issue29549@psf.upfronthosting.co.za>
2017-02-13 20:57:22rhettingerlinkissue29549 messages
2017-02-13 20:57:22rhettingercreate