[issue29549] Improve docstring for str.index
Serhiy Storchaka
report at bugs.python.org
Thu Feb 23 18:30:03 EST 2017
Serhiy Storchaka added the comment:
Write docstrings in following style:
"index($self, sub, start=0, end=sys.maxsize, /)\n"
"--\n"
"\n"
"<The summary line>\n"
"\n"
"<Rest of multiline\n"
"description>"
Extract the summary line. Don't use the metavariable "S" since it no longer defined in the signature.
----------
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue29549>
_______________________________________
More information about the Python-bugs-list
mailing list