[issue13437] Provide links to the source code for every module in the documentation

Changes by A.M. Kuchling : -- resolution: -> fixed stage: commit review -> committed/rejected status: open -> closed ___ Python tracker ___ _

[issue13437] Provide links to the source code for every module in the documentation

Roundup Robot added the comment: New changeset bc107f5faedc by Andrew Kuchling in branch 'default': #13437: link to the source code for a few more modules http://hg.python.org/cpython/rev/bc107f5faedc -- nosy: +python-dev ___ Python tracker

[issue13437] Provide links to the source code for every module in the documentation

Éric Araujo added the comment: Agreed with Terry. Some Python modules are just wrappers for C modules, but datetime.py is standalone so we can dispense with the link to _datetime.c. -- ___ Python tracker

[issue13437] Provide links to the source code for every module in the documentation

Terry J. Reedy added the comment: With rare exceptions*, my inclination is to only link .py files anyway. Those apply to all implementations that use them as is. Any Python programmer can read them and maybe learn something. The C files only apply to CPython. The possible existence of a _modna

[issue13437] Provide links to the source code for every module in the documentation

A.M. Kuchling added the comment: Terry: yes, the code for _decimal.c doesn't look especially helpful. (_csv.c is a bit more straightforward, but still isn't highly commented.) The problem is that decimal.py does have long docstrings & discussions, so it's certainly useful. Is it inconsistent

[issue13437] Provide links to the source code for every module in the documentation

Terry J. Reedy added the comment: Without actually looking, I am skeptical of _decimal.c as I expect the code to be highly technical. But maybe it has more helpful comments than I expect. But I am willing to let the person pushing decide. I am overall in favor of linking to python sources. di

[issue13437] Provide links to the source code for every module in the documentation

Éric Araujo added the comment: +1 on amk’s patch. I trust his selection of modules, and linking to C module sources can be an interesting experiment. -- stage: -> commit review versions: +Python 3.4, Python 3.5 -Python 3.2, Python 3.3 ___ Python tr

[issue13437] Provide links to the source code for every module in the documentation

A.M. Kuchling added the comment: Here's a patch for some of Julian's suggested modules. I went through Julian's list and included code links for the ones that a) weren't packages or only written in C, b) only had one Python file (which excluded os.path = posixpath.py/ntpath.py) and c) had doc

[issue13437] Provide links to the source code for every module in the documentation

Julian Berman added the comment: Well, if there's opposition I don't know how strongly I feel about this then, but I generally agree with you Ezio, if there's an occasion where 1) applies fixing the docs is certainly reasonable. If I'm checking the source though, it's not necessarily since th

[issue13437] Provide links to the source code for every module in the documentation

Changes by Terry J. Reedy : -- nosy: +terry.reedy ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.p

[issue13437] Provide links to the source code for every module in the documentation

Ezio Melotti added the comment: There are usually two cases that lead me to check the code: 1) The documentation is incomplete, not clear, missing, or plain wrong; 2) I want to check how something is implemented, mostly just out of curiosity; Regarding the first case, in theory the docs should

[issue13437] Provide links to the source code for every module in the documentation

Julian Berman added the comment: Here's first a quick list from one pass over the docs. I've attempted to limit myself to a few like you've suggested, though I'll wait for confirmation that Raymond is not willing to simply add them to everything once we're at it :). http://docs.python.org/lib

[issue13437] Provide links to the source code for every module in the documentation

Changes by Ezio Melotti : -- nosy: +ezio.melotti ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.py

[issue13437] Provide links to the source code for every module in the documentation

Éric Araujo added the comment: Hi Julian, thanks for your interest in improving Python and welcome! It is Raymond who initially added these links, and I helped porting them between versions. The criterion can be read in the commit message: “Provide links to Python source in a handful of cas

[issue13437] Provide links to the source code for every module in the documentation

New submission from Julian Berman : The documentation occasionally contains a link to the source code for a module in the stdlib. See for instance http://docs.python.org/library/urlparse.html and http://docs.python.org/library/collections.html , or many others. With a quick perusal, I couldn't