This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author paul.j3
Recipients BreamoreBoy, bethard, docs@python, eric.araujo, jaraco, paul.j3, python-dev, terry.reedy, tshepang
Date 2014-08-24.05:14:27
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1408857268.42.0.0231257961125.issue13540@psf.upfronthosting.co.za>
In-reply-to
Content
While we are talking the Action class, the documentation isn't clear that the 'add_argument' method returns an Action object, specifically one the subclasses.  More than once, when answering Stackoverflow questions I've recommended assigning this object to a variable for use later in the script. 

    a = parser.add_argument(...)
    ...
    print a.dest
    a.help = 'change the help'
    a.required = True
    ...

The doc mentions that 'add_subparsers' 'returns a special action object.'

In sum, I think the documentation needs a sentence or two that describe what add_argument returns.  I'm less sure whether it should include an example of using that return.
History
Date User Action Args
2014-08-24 05:14:28paul.j3setrecipients: + paul.j3, terry.reedy, jaraco, bethard, eric.araujo, docs@python, BreamoreBoy, tshepang, python-dev
2014-08-24 05:14:28paul.j3setmessageid: <1408857268.42.0.0231257961125.issue13540@psf.upfronthosting.co.za>
2014-08-24 05:14:28paul.j3linkissue13540 messages
2014-08-24 05:14:27paul.j3create