[Python-Dev] Best practice for documentation for std lib
solipsis at pitrou.net
Sun Sep 22 10:20:46 CEST 2013
On Sun, 22 Sep 2013 13:13:04 +1000
Steven D'Aprano <steve at pearwood.info> wrote:
> Hi all,
> I have a question about how I should manage documentation for the
> statistics module for Python 3.4. At the moment, I have extensive
> docstrings in the module itself. I don't believe anyone has flagged that
> as "too much information" in a code review, so I'm going to assume that
> large docstrings will be acceptable.
Related question: do the extensive docstrings make "help(stats)"
painful to browse through?
More information about the Python-Dev