[docs] [issue13249] argparse.ArgumentParser() lists arguments in the wrong order

Éric Araujo report at bugs.python.org
Mon Nov 14 17:58:11 CET 2011

Éric Araujo <merwok at netwok.org> added the comment:

I would not use a note directive.  Notes and warnings distract and sometimes scare readers.  For a simple coding recommendation like this, I think a regular paragraph would suffice.  To make sure it’s not lost after pages of options description, maybe it could be put right after the signature?  Also, it would be nice to explicit the why of this recommendation (e.g. “due to the number of arguments, it is recommended to always use keyword arguments for this function”).


Python tracker <report at bugs.python.org>

More information about the docs mailing list