Missing hint to source code

[FriedrichSpeevonLangenfeld]

BPO	22528

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-10-02.06:40:07.222>
created_at = <Date 2014-09-30.19:45:40.214>
labels = ['docs']
title = 'Missing hint to source code'
updated_at = <Date 2014-10-02.06:40:07.220>
user = 'https://bugs.python.org/FriedrichSpeevonLangenfeld'

bugs.python.org fields:

activity = <Date 2014-10-02.06:40:07.220>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-10-02.06:40:07.222>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2014-09-30.19:45:40.214>
creator = 'Friedrich.Spee.von.Langenfeld'
dependencies = []
files = []
hgrepos = []
issue_num = 22528
keywords = []
message_count = 4.0
messages = ['227989', '227993', '228079', '228165']
nosy_count = 3.0
nosy_names = ['docs@python', 'python-dev', 'Friedrich.Spee.von.Langenfeld']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue22528'
versions = []

[FriedrichSpeevonLangenfeld]

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.

[python-dev]

New changeset 04f82abdfb6d by Benjamin Peterson in branch '3.4':
add link to pdb source (closes bpo-22528)
https://hg.python.org/cpython/rev/04f82abdfb6d

New changeset d49b9c8ee8ed by Benjamin Peterson in branch '2.7':
add link to pdb source (closes bpo-22528)
https://hg.python.org/cpython/rev/d49b9c8ee8ed

New changeset 26b767fec7e2 by Benjamin Peterson in branch 'default':
merge 3.4 (bpo-22528)
https://hg.python.org/cpython/rev/26b767fec7e2

[FriedrichSpeevonLangenfeld]

Excuse me, but it would be nice to fix the documentation of the modules symtable and compileall too. Thanks.

[python-dev]

New changeset b51742cb1685 by Georg Brandl in branch '3.4':
closes bpo-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 bpo-22528: add source links to symtable and compileall
https://hg.python.org/cpython/rev/5144c7d0ef29