diff options
author | Alexander Belopolsky <alexander.belopolsky@gmail.com> | 2010-11-18 01:52:54 (GMT) |
---|---|---|
committer | Alexander Belopolsky <alexander.belopolsky@gmail.com> | 2010-11-18 01:52:54 (GMT) |
commit | a47bbf5a4b6aaba52be774ddd2cb23be26a638ef (patch) | |
tree | de599d78aab41cbbcd75083d2581a2aea39fb527 /Doc/library/pydoc.rst | |
parent | f609654b0e36796275b7c9f822349e89fe9b4f2d (diff) | |
download | cpython-a47bbf5a4b6aaba52be774ddd2cb23be26a638ef.zip cpython-a47bbf5a4b6aaba52be774ddd2cb23be26a638ef.tar.gz cpython-a47bbf5a4b6aaba52be774ddd2cb23be26a638ef.tar.bz2 |
Issue #10446: Several changes to module documentation generated by pydoc:
1. Online reference manual link is now version-specific and the
'MODULE DOCS' section renamed to 'MODULE REFERENCE'.
2. 'FILE' section is moved to the end of the file.
3. Special names processed by pydoc such as __version__ or __credits__
are now excluded from the DATA section.
4. Defined __all__ to prevent pydoc from exposing undocumented details
about itself.
5. Removed Python 2.3 compatibility code.
Diffstat (limited to 'Doc/library/pydoc.rst')
-rw-r--r-- | Doc/library/pydoc.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index 4103dd4..cbb8af8 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -63,7 +63,9 @@ documents precisely the version of the module you would get if you started the Python interpreter and typed ``import spam``. Module docs for core modules are assumed to reside in -http://docs.python.org/library/. This can be overridden by setting the -:envvar:`PYTHONDOCS` environment variable to a different URL or to a local -directory containing the Library Reference Manual pages. +``http://docs.python.org/X.Y/library/`` where ``X`` and ``Y`` are the +major and minor version numbers of the Python interpreter. This can +be overridden by setting the :envvar:`PYTHONDOCS` environment variable +to a different URL or to a local directory containing the Library +Reference Manual pages. |