Alex Kleider <aklei...@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
_______________________________________________
Tutor maillist - Tutor@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
