[Python-Dev] Best practice for documentation for std lib

Guido van Rossum guido at python.org
Sun Sep 22 20:34:56 CEST 2013


On Sun, Sep 22, 2013 at 11:02 AM, Westley Martínez <anikom15 at gmail.com>wrote:

> Since help() is usually the first thing I use to remind myself of an
> API, it's imperative that the doc strings are up to date and make sense
> to end users.
>
> So, autogeneration of doc strings would be good for someone like me who
> hardly uses the html docs.
>

You seem to misunderstand the use of "autogeneration". It refers to
generating the .rst docs from the docstrings in the source. And FWIW, I'm
against that practice.

-- 
--Guido van Rossum (python.org/~guido)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20130922/1425e7e9/attachment-0001.html>


More information about the Python-Dev mailing list