[docs] argparse doc introduction is inappropriately targeted (issue 26602)
vadmium+py at gmail.com
vadmium+py at gmail.com
Tue Mar 14 04:19:39 EDT 2017
https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst
File Doc/library/argparse.rst (right):
https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#newcode31
Doc/library/argparse.rst:31: The following code is a Python program that
takes a String and outputs the
String doesn’t need to be capitalized I don’t think
https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#newcode37
Doc/library/argparse.rst:37: parser.add_argument("message", help='Type
in any message')
I find starting parameter descriptions with lower case is more
consistent with the default description for “--help”:
positional arguments:
message Type in any message
optional arguments:
-h, --help show this help message and exit
https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#newcode40
Doc/library/argparse.rst:40: print args.message[:1]
You seem to be replacing a Python 3 example with Python 2 syntax.
https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#newcode52
Doc/library/argparse.rst:52: message type in any message
Spacing seems off. Also casing of “Type” is different to in the code.
https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#newcode103
Doc/library/argparse.rst:103: >>> parser.add_argument('message',
help='an integer for the accumulator')
Looks like this is unfinished, a cross between the old and new examples
:)
https://bugs.python.org/review/26602/
More information about the docs
mailing list