[issue22528] Missing hint to source code
New submission from Friedrich Spee von Langenfeld: Nearly every module entry in the documentation has a headline with the pattern <module name -- description>, followed (in the second line) by <Source code: directory>. In the entry concerning pdb (https://docs.python.org/3/library/pdb.html), there is no hint where the source code is located. This is especially annoying, because the user of the Python Debugger is explicitely invented to extend the module´s capabilities ("The debugger is extensible – it is actually defined as the class Pdb. This is currently undocumented but easily understood by reading the source."). A link to the source code should be added as the second line. The same thing should done for symtable, compileall and perhaps some other modules, which I haven´t checked by now. ---------- assignee: docs@python components: Documentation messages: 227989 nosy: Friedrich.Spee.von.Langenfeld, docs@python priority: normal severity: normal status: open title: Missing hint to source code _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue22528> _______________________________________
Roundup Robot added the comment: New changeset 04f82abdfb6d by Benjamin Peterson in branch '3.4': add link to pdb source (closes #22528) https://hg.python.org/cpython/rev/04f82abdfb6d New changeset d49b9c8ee8ed by Benjamin Peterson in branch '2.7': add link to pdb source (closes #22528) https://hg.python.org/cpython/rev/d49b9c8ee8ed New changeset 26b767fec7e2 by Benjamin Peterson in branch 'default': merge 3.4 (#22528) https://hg.python.org/cpython/rev/26b767fec7e2 ---------- nosy: +python-dev resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue22528> _______________________________________
Friedrich Spee von Langenfeld added the comment: Excuse me, but it would be nice to fix the documentation of the modules symtable and compileall too. Thanks. ---------- resolution: fixed -> status: closed -> open _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue22528> _______________________________________
Roundup Robot added the comment: New changeset b51742cb1685 by Georg Brandl in branch '3.4': closes #22528: add source links to symtable and compileall https://hg.python.org/cpython/rev/b51742cb1685 New changeset 5144c7d0ef29 by Georg Brandl in branch '2.7': closes #22528: add source links to symtable and compileall https://hg.python.org/cpython/rev/5144c7d0ef29 ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue22528> _______________________________________
participants (2)
-
Friedrich Spee von Langenfeld
-
Roundup Robot