[issue11176] give more meaningful argument names in argparse documentation

Change by Mark Lawrence : -- nosy: -BreamoreBoy ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail

[issue11176] give more meaningful argument names in argparse documentation

Steve added the comment: I came here to file a bug against the argparse documentation because reading through the documentation I didn't realize a good usecase for the `epilog` argument to the `ArgumentParser()` class until I started noticing that some commandline tools end with examples of us

[issue11176] give more meaningful argument names in argparse documentation

Mark Lawrence added the comment: If we've got some meaningful changes can we please get them committed. However I'd like to state that with over 4000 issues open we've got better things to do than change docs because somebody doesn't like the use of foo, bar and baz in examples. -- n

[issue11176] give more meaningful argument names in argparse documentation

Georg Brandl added the comment: > Also see this e-mail to docs@: > http://mail.python.org/pipermail/docs/2012-December/012028.html No, please don't see this e-mail. It's not worth it. The poster clearly has no clue whatsoever about either a) common placeholders, or b) manners. I don't want t

[issue11176] give more meaningful argument names in argparse documentation

Westley Martínez added the comment: I've skimmed through the patches. Good job kids. This is much better than it was before. No more of that silly command-line calculator or the foobar nonsense that sounds drier than the POSIX standard. Is there anything else that needs to be done? ---

[issue11176] give more meaningful argument names in argparse documentation

Chris Jerdonek added the comment: Issue 16933 improved the "choices" examples. -- ___ Python tracker ___ ___ Python-bugs-list mailing

[issue11176] give more meaningful argument names in argparse documentation

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

[issue11176] give more meaningful argument names in argparse documentation

David Lam added the comment: here's a patch that covers all but one of the foo/bar/baz examples it also has fixes for the sample code near the beginning from the review Ezio did the one example I didn't do was the "Arguments containing -" part. I guess it felt like changing the names in that

[issue11176] give more meaningful argument names in argparse documentation

Steven Bethard added the comment: Thanks for working on this! I think keeping the first example as simple is possible is probably a good idea. And I didn't have time to read through the whole patch, but as far as I went, the pizza examples looked great. -- ___

[issue11176] give more meaningful argument names in argparse documentation

David Lam added the comment: yup yup, go for it -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail

[issue11176] give more meaningful argument names in argparse documentation

Greg Roodt added the comment: I've made the minor edits required after the review to my simplification of the first example. David, perhaps we combine our efforts? Use my simple first example to explain the very basics, then continue the explanation with the pizza example? Im happy either wa

[issue11176] give more meaningful argument names in argparse documentation

Greg Roodt added the comment: Hi David Ok, I like the idea of working on a solution together. I like your idea of the pizza-making more than the current "foo bar" examples. Should we collaborate outside of the bug tracker? Greg On 9 July 2012 07:11, David Lam wrote: > > David Lam added th

[issue11176] give more meaningful argument names in argparse documentation

David Lam added the comment: haha wow, I was working on this bug too! maybe we can work on the final patch together I got through about 2/3's of the docs, so I thought it might help to upload what I got so far. I basically just made stuff up so I'm totally winning to change anything (or ev

[issue11176] give more meaningful argument names in argparse documentation

Éric Araujo added the comment: Yep, this is still open. Thanks for the patch, I did a review (if you did not get a mail, follow the link in the list of files). -- assignee: eric.araujo -> nosy: +ezio.melotti, sandro.tosi ___ Python tracker

[issue11176] give more meaningful argument names in argparse documentation

Greg Roodt added the comment: Is this still an issue? If so, I've created a simpler first example as suggested below. If we decide these docs still need a bit more work, I can also continue to provide better examples than the "foo bar" ones. -- keywords: +patch nosy: +groodt Added f

[issue11176] give more meaningful argument names in argparse documentation

Changes by Tshepang Lekhonkhobe : -- nosy: +tshepang ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mai

[issue11176] give more meaningful argument names in argparse documentation

Changes by Marc Sibson : -- nosy: +marcs ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org

[issue11176] give more meaningful argument names in argparse documentation

Changes by Adam Woodbeck : -- nosy: +adam.woodbeck ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.

[issue11176] give more meaningful argument names in argparse documentation

Éric Araujo added the comment: > I worked on this some time ago; the problem was the size of the > documentation, i.e. it was difficult to stay consistent. I think it’s okay to improve the docs one patch at a time, starting with the simple example referenced in the first message in this bug rep

[issue11176] give more meaningful argument names in argparse documentation

Westley Martínez added the comment: I worked on this some time ago; the problem was the size of the documentation, i.e. it was difficult to stay consistent. Do I have time for this? Yes, but I wouldn't get it done anytime soon, and the results could be anywhere from good to bad. As it stan

[issue11176] give more meaningful argument names in argparse documentation

Éric Araujo added the comment: Hi Westley! Do you still have time to work on this? -- keywords: +easy nosy: +eric.araujo versions: +Python 2.7, Python 3.2 ___ Python tracker __

[issue11176] give more meaningful argument names in argparse documentation

Westley Martínez added the comment: I agree; it's too artsy. I'll see if I can come up with a relevant and clever alternative. -- nosy: +anikom15 ___ Python tracker ___ ___

[issue11176] give more meaningful argument names in argparse documentation

New submission from Steven Bethard : Suggestion from a personal email: I personally am not keen on the foo/bar/baz examples. I know that you're trying to be generic but IMO it would be much easier to understand if you used meaningful names. Also, I think that the very first example you give (whi