Author belopolsky
Recipients belopolsky
Date 2010-11-17.17:32:21
SpamBayes Score 5.37498e-11
Marked as misclassified No
Message-id <1290015143.43.0.140543543356.issue10446@psf.upfronthosting.co.za>
In-reply-to
Content
$ pydoc3.1 pydoc

Help on module pydoc:

NAME
    pydoc - Generate Python documentation in HTML or text for interactive use.

FILE
    /opt/local/Library/Frameworks/Python.framework/Versions/3.1/lib/python3.1/pydoc.py

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

I suggest changing the default base URL to

http://docs.python.org/release/X.Y.Z

I would also like to take this opportunity and make some other improvements:

1. Clarify that the linked document is the authoritative reference and that generated documentation may expose functions that are considered internal and subject to change or removal.  (Suggestions for an exact wording are welcome.)

2. Move the FILE section to the end.  This will free up some screen space for an expanded "AUTHORITATIVE REFERENCE" section.  (Yes, I think the section title "MODULE DOCS" can be improved, but my mind is not set on any particular alternative.)

3. Do not include __special__ names in the DATA section.  At the very least, exclude __author__, __version__, and other special names that cause generation of document sections:

DATA
    __author__ = 'Ka-Ping Yee <ping@lfw.org>'
    __credits__ = 'Guido van Rossum, for an excellent programming l...erla...
    __date__ = '26 February 2001'
    __version__ = '$Revision: 78210 $'

VERSION
    78210

DATE
    26 February 2001
..
History
Date User Action Args
2010-11-17 17:32:23belopolskysetrecipients: + belopolsky
2010-11-17 17:32:23belopolskysetmessageid: <1290015143.43.0.140543543356.issue10446@psf.upfronthosting.co.za>
2010-11-17 17:32:21belopolskylinkissue10446 messages
2010-11-17 17:32:21belopolskycreate