[issue29549] Improve docstring for str.index

Changes by Mariatta Wijaya : -- versions: -Python 2.7 ___ Python tracker ___ ___

[issue29549] Improve docstring for str.index

Mariatta Wijaya added the comment: New changeset 577fc04a7157f6e904cffd6a0e1ad83d3460acd6 by Mariatta in branch '3.6': [3.6] bpo-29549: Fixes docstring for str.index (GH-256) (GH-1028) https://github.com/python/cpython/commit/577fc04a7157f6e904cffd6a0e1ad83d3460acd6 --

[issue29549] Improve docstring for str.index

Changes by Mariatta Wijaya : -- pull_requests: +1185 ___ Python tracker ___ ___

[issue29549] Improve docstring for str.index

Raymond Hettinger added the comment: Thanks Lisa. -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker ___

[issue29549] Improve docstring for str.index

Raymond Hettinger added the comment: New changeset 43ba8861e0ad044efafa46a7cc04e12ac5df640e by Raymond Hettinger (Lisa Roach) in branch 'master': bpo-29549: Fixes docstring for str.index (#256) https://github.com/python/cpython/commit/43ba8861e0ad044efafa46a7cc04e12ac5df640e --

[issue29549] Improve docstring for str.index

Serhiy Storchaka added the comment: Write docstrings in following style: "index($self, sub, start=0, end=sys.maxsize, /)\n" "--\n" "\n" "\n" "\n" "" Extract the summary line. Don't use the metavariable "S" since it no longer defined in the signature. --

[issue29549] Improve docstring for str.index

Mariatta Wijaya added the comment: Thanks for the PR, Lisa. Serhiy, Raymond, could you both review this? Thanks. I can do the merge and backport once it gets both of your approval :) Also,should this be applied to 3.5 too? -- ___ Python tracker

[issue29549] Improve docstring for str.index

Lisa Roach added the comment: I'll just go ahead and make my PR, let me know what else needs to be done. Serhiy, if you could point me in the direction of how to write the docstring so that it is in the Argument Clinic style I would be happy to take a look. --

[issue29549] Improve docstring for str.index

Changes by Lisa Roach : -- pull_requests: +225 ___ Python tracker ___ ___

[issue29549] Improve docstring for str.index

Serhiy Storchaka added the comment: I mean that this work is useless since it will be lost when convert str.index to Argument Clinic. Well, even when don't use Argument Clinic, but make str.index() be supported by inspect.signature(), the docstring should be significantly rewritten. I think

[issue29549] Improve docstring for str.index

Raymond Hettinger added the comment: Please everyone. Ease up. This is a very simple patch. Copy what is done in str.find to str.index. It doesn't need infinite discussion and debate. I assigned this to Lisa to give her practice. It wasn't intended to have five developers jump in and

[issue29549] Improve docstring for str.index

Xiang Zhang added the comment: Lisa, could you make a PR? It could let more developers see your patch. -- nosy: +xiang.zhang stage: needs patch -> patch review ___ Python tracker

[issue29549] Improve docstring for str.index

Raymond Hettinger added the comment: Serhiy, I'm not sure what you're referring to by "Just make docstrings in the style of of Argument Clinic descriptions". For the time being, I would like the docstring to match that of str.find(). The point of the patch is to decouple the two. AC

[issue29549] Improve docstring for str.index

Sanyam Khurana added the comment: Mariatta, I apologize for this. I completely missed to see that this was already assigned to someone else. I've withdrawn my PR. Thanks. -- nosy: +CuriousLearner ___ Python tracker

[issue29549] Improve docstring for str.index

Mariatta Wijaya added the comment: CuriousLearner, I see that you have PRs against this issue. The issue is currently assigned to Lisa. I respectfully request that you choose a different issue to work on and to withdraw your pull request. Please choose an issue that is not currently assigned

[issue29549] Improve docstring for str.index

Changes by Mark Dickinson : -- pull_requests: +172 ___ Python tracker ___ ___

[issue29549] Improve docstring for str.index

Serhiy Storchaka added the comment: No need to add Argument Clinic code. Just make docstrings in the style of of Argument Clinic descriptions. -- ___ Python tracker

[issue29549] Improve docstring for str.index

Lisa Roach added the comment: I tried to have a go at making the str.index Argument Clinic compatible, Serhiy can you take a look at my commits and let me know if this is the correct way of doing it: https://github.com/python/cpython/compare/master...lisroach:master If it looks good I will

[issue29549] Improve docstring for str.index

Changes by Nick Coghlan : -- nosy: +ncoghlan ___ Python tracker ___ ___ Python-bugs-list

[issue29549] Improve docstring for str.index

Changes by Sanyam Khurana : -- pull_requests: +107 ___ Python tracker ___ ___

[issue29549] Improve docstring for str.index

Serhiy Storchaka added the comment: str.index() still is not converted to Argument Clinic (this is not easy). The docstring needs to be rewritten when convert it to Argument Clinic in any case. It would be nice to make it Argument Clinic compatible right now. The first line line should be

[issue29549] Improve docstring for str.index

Ben Hoyt added the comment: Good call. Additionally, it's weird to me that the docstring for str.find() says "Return -1 on failure." because the string not being found is not a "failure". Like the docs (https://docs.python.org/3.5/library/stdtypes.html#str.find) say, the str.find() docstring

[issue29549] Improve docstring for str.index

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