Add quick links table to argparse docs

[rhettinger]

BPO	21150
Nosy	@rhettinger, @terryjreedy, @merwok, @lisroach, @mlouielu, @suhearsawho
PRs	bpo-21150: Add summary of argparse #1210 bpo-21150: add quick link/summary table to the top of argparse documentation #12005
Files	SampleOfSummaryTable.PNG

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2014-04-03.20:47:15.257>
labels = ['easy', 'docs']
title = 'Add quick links table to argparse docs'
updated_at = <Date 2019-02-24.03:03:06.257>
user = 'https://github.com/rhettinger'

bugs.python.org fields:

activity = <Date 2019-02-24.03:03:06.257>
actor = 'suhearsawho'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2014-04-03.20:47:15.257>
creator = 'rhettinger'
dependencies = []
files = ['45972']
hgrepos = []
issue_num = 21150
keywords = ['patch', 'easy']
message_count = 8.0
messages = ['215468', '215568', '215858', '283653', '291887', '292296', '335492', '335495']
nosy_count = 10.0
nosy_names = ['rhettinger', 'terry.reedy', 'bethard', 'eric.araujo', 'docs@python', 'paul.j3', 'lisroach', 'Gaurav Tatke', 'louielu', 'suhearsawho']
pr_nums = ['1210', '12005']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue21150'
versions = ['Python 3.5']

[rhettinger]

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.

[terryjreedy]

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.

[paulj3]

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.

[GauravTatke]

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.

[rhettinger]

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

[mlouielu]

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

[lisroach]

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.

[suhearsawho]

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