Mailing List Archive: Python: Bugs

[issue11176] give more meaningful argument names in argparse documentation

Index | Next | Previous | View Threaded

report at bugs

Jul 7, 2012, 3:13 AM

Post #1 of 7 (128 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation

Greg Roodt <groodt [at] gmail> 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 file: http://bugs.python.org/file26284/argparse_simple_example.diff

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Jul 8, 2012, 9:56 PM

Post #2 of 7 (125 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation [In reply to]

Éric Araujo <merwok [at] netwok> 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 <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Jul 8, 2012, 11:11 PM

Post #3 of 7 (122 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation [In reply to]

David Lam <d [at] dlam> 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 everything)

I made a little effort to make the examples mildly amusing, since novelty sorta helps in retention. So one of the recurring examples I used involves that of a pizza-making-program... hopefully this helps in some way!

----------
nosy: +dlam
Added file: http://bugs.python.org/file26325/issue11165-doc-fix-up-to-section-15.4.4.diff

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Jul 9, 2012, 12:02 PM

Post #4 of 7 (120 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation [In reply to]

Greg Roodt <groodt [at] gmail> 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 <report [at] bugs> wrote:

>
> David Lam <d [at] dlam> 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 everything)
>
> I made a little effort to make the examples mildly amusing, since novelty
> sorta helps in retention. So one of the recurring examples I used involves
> that of a pizza-making-program... hopefully this helps in some way!
>
> ----------
> nosy: +dlam
> Added file:
> http://bugs.python.org/file26325/issue11165-doc-fix-up-to-section-15.4.4.diff
>
> _______________________________________
> Python tracker <report [at] bugs>
> <http://bugs.python.org/issue11176>
> _______________________________________
>

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Jul 9, 2012, 12:53 PM

Post #5 of 7 (130 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation [In reply to]

Greg Roodt <groodt [at] gmail> 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 way, I quite like your example using the system dictionary.

----------
Added file: http://bugs.python.org/file26334/1176_minor_edits.diff

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Jul 17, 2012, 2:49 PM

Post #6 of 7 (104 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation [In reply to]

David Lam <d [at] dlam> added the comment:

yup yup, go for it

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

Jul 22, 2012, 4:37 PM

Post #7 of 7 (103 views)
Permalink

[issue11176] give more meaningful argument names in argparse documentation [In reply to]

Steven Bethard <steven.bethard [at] gmail> 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.

----------

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue11176>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads