[issue13850] Summary tables for argparse add_argument options

Stéphane Wirtel added the comment: I close my PR, if anyone wants to submit an other PR, feel free to do it. -- ___ Python tracker ___

[issue13850] Summary tables for argparse add_argument options

Stéphane Wirtel added the comment: Hi @Raymond, Yep, I understand about the "look", I have seen the result after the build of the doc but the patch was like that and I did not want to change the initial patch. Would you suggest one layout and I could update the PR with your

[issue13850] Summary tables for argparse add_argument options

Raymond Hettinger added the comment: I like the idea of having various summary tables for argparse, but the one in the PR isn't visually attractive or self-explanatory. -- ___ Python tracker

[issue13850] Summary tables for argparse add_argument options

Stéphane Wirtel added the comment: just for 2.7, 3.7 & 3.8 because they are in bugfix mode. -- versions: +Python 3.7, Python 3.8 -Python 3.4, Python 3.5 ___ Python tracker ___

[issue13850] Summary tables for argparse add_argument options

Change by Stéphane Wirtel : -- pull_requests: +12090 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue13850] Summary tables for argparse add_argument options

Change by Mark Lawrence : -- nosy: -BreamoreBoy ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue13850] Summary tables for argparse add_argument options

Tina Zhang added the comment: Created Quick Reference table subsection under the add_argument() method section - used the table originally created by xmorel, replacing ticks with 'x' and adding links to the sections in the documentation for each parameter names. Removed the 'version' column

[issue13850] Summary tables for argparse add_argument options

R. David Murray added the comment: I think it would be better to move the summary table to the end (just before the Action section), and add another link to the summary to the sentence The following sections describe how each of these are used. That is, follow that sentence with something

[issue13850] Summary tables for argparse add_argument options

Stéphane Wirtel added the comment: Hi all, If you think the patch is ok, please merge it, we will close this issue. Thanks -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue13850 ___

[issue13850] Summary tables for argparse add_argument options

Stéphane Wirtel added the comment: On 13 Apr 2015, at 10:56, Stéphane Wirtel wrote: Stéphane Wirtel added the comment: Just updated this patch with x instead of the unicode character. Sorry bad patch, I have read the last comment (“replace by x or “yes/no”) and not the other comments.

[issue13850] Summary tables for argparse add_argument options

Stéphane Wirtel added the comment: Just updated this patch with x instead of the unicode character. -- nosy: +matrixise Added file: http://bugs.python.org/file38917/argparse-actions-matrix-v2 ___ Python tracker rep...@bugs.python.org

[issue13850] Summary tables for argparse add_argument options

Mark Lawrence added the comment: At a quick glance the patch looks okay to me so as there's been a lot of positive comments can we have a formal patch review please. -- nosy: +BreamoreBoy versions: +Python 3.4, Python 3.5 -Python 3.2, Python 3.3 ___

[issue13850] Summary tables for argparse add_argument options

Changes by Berker Peksag berker.pek...@gmail.com: -- nosy: +berker.peksag ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue13850 ___ ___

[issue13850] Summary tables for argparse add_argument options

Ezio Melotti ezio.melo...@gmail.com added the comment: * It's incredibly not helpful for people who don't know argparse Indeed. Maybe this should be moved down in the page, and possibly provide a link to the top (see e.g. the unittest doc [0] and the link on top to jump to the list of

[issue13850] Summary tables for argparse add_argument options

Xavier Morel xavier.mo...@masklinn.net added the comment: Had some time to play with this today, here's a draft matrix of actions and add_argument parameters which is pretty readable, but: * It's incredibly not helpful for people who don't know argparse * I tried adding effects descriptions in

[issue13850] Summary tables for argparse add_argument options

Xavier Morel xavier.mo...@masklinn.net added the comment: completion for list item 4: although it would definitely make the raw text (in-rst) much harder to read compared to the current table (which can be used from the rst source without compiling) --

[issue13850] Summary tables for argparse add_argument options

Changes by Tshepang Lekhonkhobe tshep...@gmail.com: -- nosy: +tshepang ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue13850 ___ ___

[issue13850] Summary tables for argparse add_argument options

Changes by Éric Araujo mer...@netwok.org: -- nosy: +eric.araujo ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue13850 ___ ___ Python-bugs-list

[issue13850] Summary tables for argparse add_argument options

Xavier Morel xavier.mo...@masklinn.net added the comment: Creating the tables should not be too hard, especially using e.g. org-mode, but: 1. Where should those tables live? The argparse documentation is pretty big and there's no completely obvious place. I would guess table 1. could just

[issue13850] Summary tables for argparse add_argument options

Nick Coghlan ncogh...@gmail.com added the comment: My specific suggestion is to have a dedicated Quick Reference section before the first example. This section would be aimed at two groups of people: - those wanting a quick overview of the features argparse offers them (This looks

[issue13850] Summary tables for argparse add_argument options

Changes by Ezio Melotti ezio.melo...@gmail.com: -- nosy: +ezio.melotti ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue13850 ___ ___

[issue13850] Summary tables for argparse add_argument options

Xavier Morel xavier.mo...@masklinn.net added the comment: My specific suggestion is to have a dedicated Quick Reference section before the first example. OK, that looks like a good plan. -- ___ Python tracker rep...@bugs.python.org

[issue13850] Summary tables for argparse add_argument options

Steven Bethard steven.beth...@gmail.com added the comment: Sounds like an excellent plan to me too. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue13850 ___

[issue13850] Summary tables for argparse add_argument options

Xavier Morel xavier.mo...@masklinn.net added the comment: The Parameters column would span multiple lines, with one parameter and a brief description of the parameter on each line. I started looking into that, and it turns out that's more annoying than expected: a bunch of parameters are

[issue13850] Summary tables for argparse add_argument options

Nick Coghlan ncogh...@gmail.com added the comment: Having a second table of Applicable Parameters could definitely work. I don't think the no horizontal headers limitation should be a big problem - the matrix should be readable even if the action names are just listed in an ordinary column.

[issue13850] Summary tables for argparse add_argument options

Raymond Hettinger raymond.hettin...@gmail.com added the comment: +1 from me. The docs in their present form are a great tutorial but are a total failure as a quick reference. Besides having table of parameters, it may also be worthwhile to move some of the examples to a HOWTO document (much

[issue13850] Summary tables for argparse add_argument options

New submission from Nick Coghlan ncogh...@gmail.com: With the current argparse docs, it's very hard to get a quick reminder of how to spell the various parameters for add_argument, and just what they do. This issue suggests adding a Quick Reference section for add_argument, with the following

[issue13850] Summary tables for argparse add_argument options

Nick Coghlan ncogh...@gmail.com added the comment: Looking at the docs, a 4th table in the quick reference section would be useful: the parameters for ArgumentParser itself. Note that the ArgumentParser and add_arguments() parameters are already summarised in their respective entries, but