[issue11807] Documentation of add_subparsers lacks information about parametres
New submission from Filip Gruszczyński <gruszczy@gmail.com>: In argparse documentation parametres of add_subparsers are not listed. And yet there are some really useful parametres like parser_class. It would be useful, it they were described there well and one wouldn't have to look into the code to find them :-) I'll be happy to provide documentation patch tomorrow. ---------- assignee: docs@python components: Documentation messages: 133379 nosy: docs@python, gruszczy priority: normal severity: normal status: open title: Documentation of add_subparsers lacks information about parametres versions: Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Changes by Filip Gruszczyński <gruszczy@gmail.com>: ---------- nosy: +bethard _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Filip Gruszczyński <gruszczy@gmail.com> added the comment: Here is a patch for this. I am not much of technical writer, so please be patient with me. I tried to provide all the information about parameters, that can be inferred from the code and experimenting. I have left out one parameter - action - because I don't see any use of it for a potential user and potential description seemed very complicated. I'll be happy to work further on the patch, if someone is willing to tutor me a little. ---------- keywords: +patch Added file: http://bugs.python.org/file21604/11807.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Steven Bethard <steven.bethard@gmail.com> added the comment: Looks good. A few minor comments (click "review" by the patch). ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Filip Gruszczyński <gruszczy@gmail.com> added the comment: Fixed patch. ---------- Added file: http://bugs.python.org/file24042/11807_2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Filip Gruszczyński <gruszczy@gmail.com> added the comment: Bump! I would like to remind about this issue and patch. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Steven Bethard <steven.bethard@gmail.com> added the comment: Looks good. There was one typo in "parametres" that I've fixed. Should be ready to apply. ---------- Added file: http://bugs.python.org/file26469/11807_3.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Roundup Robot added the comment: New changeset b930b4e67c8a by Georg Brandl in branch '3.3': Closes #11807: document argparse add_subparsers method better. http://hg.python.org/cpython/rev/b930b4e67c8a ---------- nosy: +python-dev resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
Roundup Robot added the comment: New changeset d5027e489c25 by Georg Brandl in branch '2.7': Closes #11807: document argparse add_subparsers method better. http://hg.python.org/cpython/rev/d5027e489c25 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________
participants (3)
-
Filip Gruszczyński -
Roundup Robot
-
Steven Bethard