New submission from Éric Araujo <merwok@netwok.org>: 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. ---------- assignee: docs@python components: Documentation messages: 138002 nosy: docs@python, eric.araujo priority: normal severity: normal status: open title: Document pydoc.help versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: There is already a link to the main entry, which is where I think it should be. ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Stéphane Wirtel added the comment: What can we do for this issue ? ---------- nosy: +matrixise _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Terry J. Reedy added the comment: 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 ---------- resolution: -> works for me stage: -> resolved status: open -> closed type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Éric Araujo added the comment: Works for me. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: There is already a link to the main entry, which is where I think it should be. ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Stéphane Wirtel added the comment: What can we do for this issue ? ---------- nosy: +matrixise _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Terry J. Reedy added the comment: 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 ---------- resolution: -> works for me stage: -> resolved status: open -> closed type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
Éric Araujo added the comment: Works for me. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12300> _______________________________________
participants (3)
-
Stéphane Wirtel -
Terry J. Reedy
-
Éric Araujo