Description

rhettinger

opened on Apr 3, 2014

Issue body actions

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']

Activity

1. rhettinger commented on Apr 3, 2014

   

   rhettinger

   on Apr 3, 2014

   ContributorAuthor

   More actions

   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.
2. rhettinger

   assigned

   docspython

   on Apr 3, 2014
3. rhettinger

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   easy

   on Apr 3, 2014
4. terryjreedy commented on Apr 4, 2014

   

   terryjreedy

   on Apr 4, 2014

   Member

   More actions

   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.
5. paulj3 commented on Apr 10, 2014

   

   paulj3mannequin

   on Apr 10, 2014

   Mannequin

   More actions

   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.
6. GauravTatke commented on Dec 19, 2016

   

   GauravTatkemannequin

   on Dec 19, 2016

   Mannequin

   More actions

   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.
7. rhettinger commented on Apr 19, 2017

   

   rhettinger

   on Apr 19, 2017

   ContributorAuthor

   More actions

   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 ).
8. mlouielu commented on Apr 26, 2017

   

   mlouielumannequin

   on Apr 26, 2017

   Mannequin

   More actions

   Could Raymond, Gaurav or paul help to review the PR's summary table?
   Thanks!
9. lisroach commented on Feb 14, 2019

   

   lisroach

   on Feb 14, 2019

   Contributor

   More actions

   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.
10. suhearsawho commented on Feb 14, 2019

    

    suhearsawhomannequin

    on Feb 14, 2019

    Mannequin

    More actions

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

    transferred this issue fromon Apr 10, 2022
12. erlend-aasland

    added this to Argparse issueson May 19, 2022
13. erlend-aasland

    moved this to Doc issues in Argparse issueson May 19, 2022
14. JulienPalard commented on Jul 10, 2022

    

    JulienPalard

    on Jul 10, 2022

    Member

    More actions

    #12005 has been merged, it adds a Quick Links for add_argument()", for me it's enough to close this issue.

    Does anyone think we need more than add_argument quicklinks?

    Reacted by Éric and Shantanu
15. hauntsaninja commented on Jul 17, 2022

    

    hauntsaninja

    on Jul 17, 2022

    Contributor

    More actions

    Closing, since #12005 was merged and it looks like #91726 and #91762 addressed the open comments on #12005

    Reacted by Éric
16. hauntsaninja

    closed this as completedon Jul 17, 2022
17. erlend-aasland

    moved this from Doc issues to Done in Argparse issueson Jul 30, 2022

Issue actions