[issue21150] Add quick links table to argparse docs

[Susan Su]

Change by Susan Su :


--
keywords: +patch
pull_requests: +12036
stage: needs patch -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Susan Su]

Susan Su  added the comment:

I'm available to start working on this bug. Please let me know if any 
suggestions, concerns or comments come up! Thank you.

--
nosy: +suhearsawho

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Lisa Roach]

Lisa Roach  added the comment:

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.

--
nosy: +lisroach

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Louie Lu]

Louie Lu added the comment:

Could Raymond, Gaurav or paul help to review the PR's summary table?
Thanks!

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Louie Lu]

Changes by Louie Lu :


--
pull_requests: +1332

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Raymond Hettinger]

Changes by Raymond Hettinger :


--
nosy: +bethard

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Raymond Hettinger]

Raymond Hettinger added the comment:

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 ).

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Louie Lu]

Changes by Louie Lu :


--
nosy: +louielu

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Gaurav Tatke]

Gaurav Tatke added the comment:

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.

--
nosy: +Gaurav Tatke
Added file: http://bugs.python.org/file45972/SampleOfSummaryTable.PNG

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[paul j3]

paul j3 added the comment:

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.

--
nosy: +paul.j3

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue21150
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Éric Araujo]

Changes by Éric Araujo mer...@netwok.org:


--
nosy: +eric.araujo

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue21150
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Terry J. Reedy]

Terry J. Reedy added the comment:

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.

--
nosy: +terry.reedy

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue21150
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue21150] Add quick links table to argparse docs

[Raymond Hettinger]

New submission from Raymond Hettinger:

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.

--
assignee: docs@python
components: Documentation
keywords: easy
messages: 215468
nosy: docs@python, rhettinger
priority: normal
severity: normal
stage: needs patch
status: open
title: Add quick links table to argparse docs
versions: Python 3.5

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue21150
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com