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

Victor Stinner victor.stinner at gmail.com
Sun Sep 22 09:58:42 CEST 2013

I don't like having to browse the source code to read the documentation. I prefer short docstring and longer reST documentation. In ReST, you get a table of content and nice links to functions, modules, etc.

When I read doc, I like having two levels: tutorial listing most important functions and parameters with examples, and a full API doc.

Using reST, you can also use tables, notes, footnotes, etc.

Victor -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://mail.python.org/pipermail/python-dev/attachments/20130922/3017cf02/attachment.html>

More information about the Python-Dev mailing list