[Python-Dev] Best practice for documentation for std lib (original) (raw)

Westley Martínez anikom15 at gmail.com
Sun Sep 22 21:24:04 CEST 2013

From: gvanrossum at gmail.com [mailto:gvanrossum at gmail.com] On Behalf Of Guido van Rossum Sent: Sunday, September 22, 2013 11:35 AM

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.

Oh I see. Well in that case, the docstrings can still become outdated, and so then the .rst docs will be outdated, too. It doesn't seem to offer much benefit since you still have to keep both updated, plus you have an extra tool that must be maintained.

More information about the Python-Dev mailing list