Python 3 - Second Edition

37    Documentation

If you distribute your programs and modules to users and other developers, good documentation is very important. Without a reasonable description, even the best program is worthless as it’s too much work to infer the functionality from the source code alone or to guess it by trial and error.

Programmers often find writing documentation a nuisance because it takes a relatively large amount of time without improving the programs themselves. For this reason, there are many modules and programs in the Python world that haven’t been sufficiently documented.

However, there are tools and methods that make writing documentation as easy as possible. In this section, we’ll look pydoc, which can be used to document Python programs based ...