This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Document pydoc.help
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: works for me
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, matrixise, terry.reedy
Priority: normal Keywords:

Created on 2011-06-09 16:18 by eric.araujo, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (5)
msg138002 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-06-09 16:18
The only public function in pydoc is help, and it’s not listed in the module docs.  The existing doc in library/functions could be moved to library/pydoc.  See also #12299.
msg138149 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-06-11 02:40
There is already a link to the main entry, which is where I think it should be.
msg254021 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-11-03 21:37
What can we do for this issue ?
msg254023 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2015-11-03 21:56
Close it, which I think Éric implicitly agreed to in paired issue #12299, where I said more in opposition to this one.  What I meant above is that help() is 'listed' in https://docs.python.org/3/library/pydoc.html#module-pydoc.
While it does not have usual format there, it is linked to a full entry here
https://docs.python.org/3/library/functions.html#help
msg254025 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2015-11-03 21:58
Works for me.
History
Date User Action Args
2022-04-11 14:57:18adminsetgithub: 56509
2015-11-03 21:58:36eric.araujosetmessages: + msg254025
2015-11-03 21:56:10terry.reedysetstatus: open -> closed
type: enhancement
messages: + msg254023

resolution: works for me
stage: resolved
2015-11-03 21:37:42matrixisesetnosy: + matrixise
messages: + msg254021
2011-06-11 02:40:37terry.reedysetnosy: + terry.reedy
messages: + msg138149
2011-06-09 16:18:59eric.araujocreate