classification
Title: Add quick links table to argparse docs
Type: Stage: patch review
Components: Documentation Versions: Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Gaurav Tatke, bethard, docs@python, eric.araujo, lisroach, louielu, paul.j3, rhettinger, suhearsawho, terry.reedy
Priority: normal Keywords: easy, patch

Created on 2014-04-03 20:47 by rhettinger, last changed 2019-02-24 03:03 by suhearsawho.

Files
File name Uploaded Description Edit
SampleOfSummaryTable.PNG Gaurav Tatke, 2016-12-19 23:24
Pull Requests
URL Status Linked Edit
PR 1210 open louielu, 2017-04-20 06:06
PR 12005 open suhearsawho, 2019-02-24 03:03
Messages (8)
msg215468 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2014-04-03 20:47
The argparse module has many functions and options.

It would benefit from a summary and quick links table at the top of the page just like we have for the itertools module docs and the builtins module docs.
msg215568 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-04-04 21:47
I have used both quick link tables and agree that more would be nice in spite of the added maintenance burden. The re module is one I would like to see indexed.
msg215858 - (view) Author: paul j3 (paul.j3) * (Python triager) Date: 2014-04-10 00:12
While 'argparse' is complex, its organization is quite different from 'itertools'.  For most purposes there is one starting point:

    parser = argparse.ArgumentParser(...)

Nearly everything else invokes a 'parser'  method.  Most complex and common is 'add_argument'.

Some summary tables might be useful, but 'itertools' might not be best model.
msg283653 - (view) Author: Gaurav Tatke (Gaurav Tatke) * Date: 2016-12-19 23:24
Hello All,

I would like to help with this issue. I am a beginner. I am attaching a 'SampleOfSummaryTable.PNG' file which I think is one way of organizing summary table.

I think if we put quick links of function parameters in summary table then it will make existing parameter quick links above detailed summary of each parameter as redundant.

Please let me know if this is okay.
msg291887 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2017-04-19 16:43
Gaurav, overall this looks nice.  

I would drop the example column because it will make the row too wide for viewing.  Alternatively, put the examples in a separate table (as was done for the combinatoric functions in the itertools docs: https://docs.python.org/3/library/itertools.html#module-itertools ).
msg292296 - (view) Author: Louie Lu (louielu) * Date: 2017-04-26 04:01
Could Raymond, Gaurav or paul help to review the PR's summary table?
Thanks!
msg335492 - (view) Author: Lisa Roach (lisroach) * (Python committer) Date: 2019-02-14 02:34
It looks like @louielu might not be around anymore to finish this PR? If there are no objections I'd like to give a new contributor @suhearsawho a shot at this.
msg335495 - (view) Author: Susan Su (suhearsawho) * Date: 2019-02-14 06:09
I'm available to start working on this bug. Please let me know if any suggestions, concerns or comments come up! Thank you.
History
Date User Action Args
2019-02-24 03:03:06suhearsawhosetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request12036
2019-02-14 06:09:00suhearsawhosetnosy: + suhearsawho
messages: + msg335495
2019-02-14 02:34:43lisroachsetnosy: + lisroach
messages: + msg335492
2017-04-26 04:01:52louielusetmessages: + msg292296
2017-04-20 06:06:50louielusetpull_requests: + pull_request1332
2017-04-19 16:44:07rhettingersetnosy: + bethard
2017-04-19 16:43:44rhettingersetmessages: + msg291887
2017-04-19 16:32:35louielusetnosy: + louielu
2016-12-19 23:24:11Gaurav Tatkesetfiles: + SampleOfSummaryTable.PNG
nosy: + Gaurav Tatke
messages: + msg283653

2014-04-10 00:12:07paul.j3setnosy: + paul.j3
messages: + msg215858
2014-04-04 21:47:29terry.reedysetnosy: + terry.reedy
messages: + msg215568
2014-04-04 21:05:31eric.araujosetnosy: + eric.araujo
2014-04-03 20:47:15rhettingercreate