New submission from Alexander Belopolsky <belopol...@users.sourceforge.net>:

$ 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 <p...@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
..

----------
assignee: belopolsky
components: Documentation, Library (Lib)
messages: 121365
nosy: belopolsky
priority: normal
severity: normal
status: open
title: pydoc3 links to 2.x library reference
type: behavior
versions: Python 3.1, Python 3.2

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue10446>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to