Message229510
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 usage.
I found this bug and so thought it would be better to just leave a comment here instead.
I glaced through the submitted patches and noticed that the pizza making example has `epilog="Remember: select a good combination to ensure maximum tastiness` ...which while good, still might not immediately convey the usefulness of the epilog parameter (just IMHO). I think, the example would be better served by something like:
>>> pizza_parser = argparse.ArgumentParser(
... description='Make a pizza out of ingredients and toppings',
... epilog="""Examples: Create a Python Lovers pizza using the command::
... ./makepizz.py spam ham eggs
... """)
Of course this example would then also require passing a formatter_class argument to handle the wrapping ...but in essence the point of my comment is that the examples might be more useful if a 'real-world' usage is demonstrated. |
|
Date |
User |
Action |
Args |
2014-10-16 07:18:19 | lonetwin | set | recipients:
+ lonetwin, georg.brandl, bethard, ezio.melotti, eric.araujo, sandro.tosi, chris.jerdonek, docs@python, BreamoreBoy, marcs, westley.martinez, tshepang, adam.woodbeck, dlam, groodt |
2014-10-16 07:18:18 | lonetwin | set | messageid: <1413443898.76.0.033412837006.issue11176@psf.upfronthosting.co.za> |
2014-10-16 07:18:18 | lonetwin | link | issue11176 messages |
2014-10-16 07:18:18 | lonetwin | create | |
|