Equivalent of perl's Pod::Usage?

Paddy paddy3118 at googlemail.com
Thu Dec 13 17:19:31 EST 2007


On Dec 10, 11:48 am, Adam Funk <a24... at ducksburg.com> wrote:
> On 2007-12-08, Dennis Lee Bieber wrote:
>
> > On Fri, 7 Dec 2007 20:12:21 +0000, Adam Funk <a24... at ducksburg.com>
> > declaimed the following in comp.lang.python:
>
> >> I'm using to using Pod::Usage in my Perl programs (a snipped example
> >> is shown below, if you're interested) to generate a little man page
> >> when they are called with the -h option.
>
> >> Is there an equivalent in Python?
>
> >    I'd suggest you look in the Python references for docstring and/or
> > __doc__
>
> Thanks.

Adam, with doctest you can incorporate tests that show typical usage
into the documentation that are easy to keep up to date.
http://en.wikipedia.org/wiki/Doctest

- Paddy.



More information about the Python-list mailing list