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.

Title: docs do not include spec info from PEPs
Type: Stage:
Components: Documentation Versions: Python 2.2
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: fdrake Nosy List: doko, fdrake, jhylton, mloskot
Priority: normal Keywords:

Created on 2002-10-10 19:49 by doko, last changed 2022-04-10 16:05 by admin. This issue is now closed.

Messages (6)
msg12734 - (view) Author: Matthias Klose (doko) * (Python committer) Date: 2002-10-10 19:49
[please see]

The bug submitter complains, that the information found
in accepted PEPs like 252 and 253 cannot be found in
the "standard documentation" and proposes, that
accepted PEPs are included in the standard documentation.
msg12735 - (view) Author: Jeremy Hylton (jhylton) (Python triager) Date: 2002-10-11 14:48
Logged In: YES 

I don't think PEPs themselves should be included in the
documentation, but the relevant spec info should go into the
docs in an appropriate location.  I think leaving the
rationale/discussion part in the PEP is good.
msg12736 - (view) Author: Matthias Klose (doko) * (Python committer) Date: 2002-10-12 07:53
Logged In: YES 

Ok, changed the summary line.
msg12737 - (view) Author: Jeremy Hylton (jhylton) (Python triager) Date: 2002-10-14 19:39
Logged In: YES 

Well it's not a question of cutting and pasting the spec 
part of a PEP into the reference manual.  The documentation 
changes, particularly for PEPs 252 and 253, are fairly 
substantial and involve a lot more than moving some text 
around.  (I'd wager that what counts as standard features 
and what is experimental isn't entirely clear.)

To sum up, I don't think there's much point keeping a bug 
report open for this unless there are a specific set of 
PEPs with tractable documentation to move around.
msg12738 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2002-10-14 19:55
Logged In: YES 

I agree with Jeremy.  If something is described in a PEP and
implemented, documentation is necessary.  For each such
case, a separate documentation bug should be filed.  This is
especially valuable since I don't have time to follow PEP
development these days.  Specific bug reports would be very
helpful, and can get things moving a little quicker.  Such a
report should include:

- what isn't documented
- where you think documentation should be added (possibly
multiple locations)
- what the documentation should say (a reference to a PEP,
email message, or a patch would all be good), if possible.

I'm closing this report and anxiously awaiting a deluge of
very specific and helpful reports.  Thanks, Volunteer
Matthias!  ;-)
msg162482 - (view) Author: Mateusz Loskot (mloskot) * Date: 2012-06-07 17:27
I reported issue 15029 [1] which may be related to this one.

Date User Action Args
2022-04-10 16:05:44adminsetgithub: 37306
2012-06-07 17:27:59mloskotsetnosy: + mloskot
messages: + msg162482
2002-10-10 19:49:56dokocreate