classification
Title: ArgParse page in library reference rewrite
Type: Stage:
Components: Documentation Versions: Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, martin.panter, sweavo
Priority: normal Keywords:

Created on 2017-03-14 06:18 by sweavo, last changed 2017-03-14 10:09 by martin.panter.

Messages (2)
msg289569 - (view) Author: Steve Carter (sweavo) Date: 2017-03-14 06:18
Originally raise as https://github.com/python/pythondotorg/issues/1059

Although it's a reference page, it is clouded by too many examples and too little reference material. Moreover, the examples are not real-world applications of argument parsing.

I propose removing the "process some integers" example, replacing it with something more typically gnu style, e.g., myapp.py [--quiet] [--log-level _n_] [--title=STR] {get | put} [FSPEC [, FSPEC...]]. This shows the user how to to many of the common command-line tasks.

[I'm tentatively offering to do this, but I haven't yet found the content I need to revise.]
msg289576 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2017-03-14 10:09
Also see Issue 26602 and Issue 11176, each with patches. Perhaps you could help review and combine them.
History
Date User Action Args
2017-03-14 10:09:56martin.pantersetnosy: + martin.panter
messages: + msg289576
2017-03-14 06:18:04sweavocreate