[docs] [issue25314] Documentation: argparse's actions store_{true, false} default to False/True (undocumented)

paul j3 report at bugs.python.org
Tue Oct 6 22:16:23 CEST 2015

paul j3 added the comment:

I have seen questions on StackOverflow with 'store_true' and explicit `default=False` parameters.  I don't recall any where this was a problem.  Usually it's as harmless as users specifying other defaults like `action='store'`, or a dest that echos a long option, etc.

But if we are going to fix the wrong default statement in `store_const`, we might as well clarify this case as well.

I wonder if this is the time and place to add a note that specifying 'type' is not necessary (and even wrong) - re. this closed issue: http://bugs.python.org/issue24754 

Is the line  'These are special cases of ``'store_const'``' useful?   The statement echos the class definition

    class _StoreTrueAction(_StoreConstAction)

but I'm not sure it adds much to the user's understanding.  'store_true' and 'store_false' are used frequently; 'store_const' is much less common (based on SO questions).

nosy: +paul.j3

Python tracker <report at bugs.python.org>

More information about the docs mailing list