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

Skip Montanaro skip at pobox.com
Mon Sep 23 17:18:22 CEST 2013


>> It would be great if the docstring contained a link to the online
>> documentation.
>
> That would have to be a feature of help(), not hardcoded in each docstring.

That *is* a feature of the help function:

Help on built-in module sys:

>>> help(sys)
NAME
    sys

FILE
    (built-in)

MODULE DOCS
    http://docs.python.org/library/sys
...

(pydoc too, though I'm 99.9% sure they use the same underlying
facility Ping originally implemented.)

Skip


More information about the Python-Dev mailing list