In PEP style section, describe how to refer to URLs and PEPs in the

body of a PEP document.  Also describe how to refer to PEP in the
References sections, including the use of www.python.org/peps as the
preferred link.

Added a section on reporting bugs and submitting patches w.r.t. PEPs.
This commit is contained in:
Barry Warsaw 2001-07-05 18:52:25 +00:00
parent cd50ab8461
commit 633cc715aa
1 changed files with 42 additions and 2 deletions

View File

@ -226,8 +226,46 @@ PEP Style
A PEP must contain a Copyright section, and it is strongly A PEP must contain a Copyright section, and it is strongly
recommended to put the PEP in the public domain. recommended to put the PEP in the public domain.
You should footnote any URLs in the body of the PEP, and a PEP When referencing an external web page in the body of a PEP, you
should include a References section with those URLs expanded. should include the title of the page in the text, with a
footnote reference to the URL. Do not include the URL in the body
text of the PEP. E.g.
Refer to the Python Language web site [1] for more details.
...
[1] http://www.python.org
When referring to another PEP, include the PEP number in the body
text, such as "PEP 1". The title may optionally appear. Add a
footnote reference that includes the PEP's title and author. It
may optionally include the explicit URL on a separate line, but
only in the References section. Note that the pep2html.py script
will calculate URLs automatically, e.g.:
...
Refer to PEP 1 [7] for more information about PEP style
...
References
[7] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
http://www.python.org/peps/pep-0001.html
If you decide to provide an explicit URL for a PEP, please use
this as the URL template:
http://www.python.org/peps/pep-xxxx.html
PEP numbers in URLs must be padded with zeros from the left, so as
to be exactly 4 characters wide, however PEP numbers in text are
never padded.
Reporting PEP Bugs, or Submitting PEP Updates
Please use the SourceForge bug manager[6] if you want to report
problems with PEPs, or better yet, the SourceForge patch
manager[2] for submitting patches to PEPs.
References and Footnotes References and Footnotes
@ -252,6 +290,8 @@ References and Footnotes
The URL for viewing PEPs on the web is The URL for viewing PEPs on the web is
http://python.sourceforge.net/peps/ http://python.sourceforge.net/peps/
[6] http://sourceforge.net/tracker/?group_id=5470&atid=305470
Copyright Copyright