[issue11176] give more meaningful argument names in argparse documentation

[Chris Jerdonek]

Chris Jerdonek added the comment:

Also see this e-mail to docs@:

http://mail.python.org/pipermail/docs/2012-December/012028.html

> Subject: [docs] FOO and BAR
>
> Do you think it would be possible to write your documentation avoiding the silly usage of FOO and BAR everywhere? This is a very very old and boring joke, and does nothing to clarify what you are trying to clarify. If you could include real-world examples in your documentation, rather than "clever" programmer "jokes", learners such as myself would have far more respect for the good work you are obviously doing here.
>
> For example, the section on argparser is full of this sort of rubbish:
> argparse.ArgumentParser(description='A foo that bars')
>
> Under what circumstances would you ever put that in a program? Are you mad?
>
> Please take this into consideration.

----------
nosy: +chris.jerdonek

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11176>
_______________________________________