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

Paul Moore p.f.moore at gmail.com
Sun Sep 22 15:46:02 CEST 2013

On 22 September 2013 13:54, Eli Bendersky <eliben at gmail.com> wrote:

IMHO the right way to think about it is that the .rst files are by far the more important documentation. Sometimes we forget that most Python programmers are people who won't go into the source to read docstrings.

While I agree entirely with this, it's worth noting that with the increasing popularity of IPython (even outside of the scientific community), more and more people are becoming used to using docstrings as a first means of finding out about a function's behaviour.

Paul

More information about the Python-Dev mailing list