[Tutor] python 3.4 documentation

Ben Finney ben+python at benfinney.id.au
Tue Jun 16 05:09:28 CEST 2015


Alex Kleider <akleider at sonic.net> writes:

> >>> import csv
> >>> help('csv')
> ...and documentation of the modules appears in the pager!

Yes. This is positive reinforcement for writing meaningful, standardised
docstrings for every code object (module, class, function): the
docstring is automatically available for browsing at the interactive
prompt, in the context of the object itself.

The flip side is: the documentation available there is only as good as
the documentation that has been written as a docstring for that object.

Encourage authors of libraries you use to maintain and improve their
docstrings :-)

-- 
 \     “It's my belief we developed language because of our deep inner |
  `\                  need to complain.” —Jane Wagner, via Lily Tomlin |
_o__)                                                                  |
Ben Finney



More information about the Tutor mailing list