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: Source code links for JSON documentation
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, ezio.melotti, louiscipher, orsenthil, rhettinger
Priority: normal Keywords: patch

Created on 2012-06-14 04:30 by louiscipher, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
json_source_link.patch louiscipher, 2012-06-14 04:30 patch file adding links to the documentation file json.rst review
Messages (3)
msg162750 - (view) Author: Bryce Verdier (louiscipher) Date: 2012-06-14 04:30
In some parts of the documentation there are links to the source code. While looking in the JSON documentation that link isn't there.

Not sure if this is wanted or if it's complete. But I'm submitting it anyway in the hopes of feedback.
msg162976 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-06-16 16:41
The source links were added by Raymond for selected modules that he judged readable, well-written and useful companions to the documentation.  For the json.encoder and decoder modules, I don’t think this is the case: the rst doc should explain well the behavior of the default encoder/decoder and how to subclass to change this behavior.  Did you see something interesting in the code?  I only had a look through it quickly, and saw the mix of C and Python code (which can be non-trivial to follow) and a dubious idiom (binding globals as locals to optimize access on CPython—doesn’t work on PyPy).  My opinion is -1; what do other people think?
msg165993 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2012-07-21 04:48
I am with Éric on this. Looking at json/decoder.py and json/encoder.py, I too feel that source link may not be helpful as much as it is helpful for others. Docs are best here. I am closing this report. Thanks!
History
Date User Action Args
2022-04-11 14:57:31adminsetgithub: 59268
2012-07-21 04:48:09orsenthilsetstatus: open -> closed

nosy: + orsenthil
messages: + msg165993

resolution: wont fix
stage: resolved
2012-06-25 03:02:01eric.araujosetresolution: rejected -> (no value)
2012-06-16 17:20:48ezio.melottisetnosy: + ezio.melotti
resolution: rejected
2012-06-16 16:41:44eric.araujosetnosy: + rhettinger, eric.araujo

messages: + msg162976
versions: + Python 2.7, Python 3.2
2012-06-14 04:30:54louisciphercreate