From 663eabbe4aba5bbf4fd21689c78c6bf2fe3dd257 Mon Sep 17 00:00:00 2001 From: David Goodger Date: Fri, 24 Mar 2006 03:24:04 +0000 Subject: [PATCH] added Auxiliary Files section; updated URLs; updated text file description --- pep-0001.txt | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/pep-0001.txt b/pep-0001.txt index da3f312d8..c984d6307 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -25,9 +25,9 @@ documenting the design decisions that have gone into Python. The PEP author is responsible for building consensus within the community and documenting dissenting opinions. -Because the PEPs are maintained as text files under CVS control, their -revision history is the historical record of the feature proposal -[1]_. +Because the PEPs are maintained as text files in a versioned +repository, their revision history is the historical record of the +feature proposal [1]_. PEP Types @@ -229,17 +229,16 @@ PEP Formats and Templates ========================= There are two PEP formats available to authors: plaintext and -reStructuredText_. +reStructuredText_. Both are UTF-8-encoded text files. -Plaintext PEPs are written in plain ASCII text, contain minimal -structural markup, and should adhere to a rigid style. PEP 9 contains -a boilerplate template [3]_ you can use to get started writing your -plaintext PEP. +Plaintext PEPs are written with minimal structural markup that adheres +to a rigid style. PEP 9 contains a instructions and a template [3]_ +you can use to get started writing your plaintext PEP. ReStructuredText_ PEPs allow for rich markup that is still quite easy to read, but results in much better-looking and more functional HTML. -PEP 12 contains a boilerplate template [4]_ for use with -reStructuredText PEPs. +PEP 12 contains instructions and a template [4]_ for reStructuredText +PEPs. There is a Python script that converts both styles of PEPs to HTML for viewing on the web [5]_. Parsing and conversion of plaintext PEPs is @@ -326,6 +325,15 @@ Replaces header containing the number of the PEP that it rendered obsolete. +Auxiliary Files +=============== + +PEPs may include auxiliary files such as diagrams. Such files must be +named ``pep-XXXX-Y.ext``, where "XXXX" is the PEP number, "Y" is a +serial number (starting at 1), and "ext" is replaced by the actual +file extension (e.g. "png"). + + Reporting PEP Bugs, or Submitting PEP Updates ============================================= @@ -387,18 +395,18 @@ References and Footnotes http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/python/python/nondist/peps/ .. [2] PEP 2, Procedure for Adding New Modules, Faassen - (http://www.python.org/peps/pep-0002.html) + (http://www.python.org/dev/peps/pep-0002) .. [3] PEP 9, Sample Plaintext PEP Template, Warsaw - (http://www.python.org/peps/pep-0009.html) + (http://www.python.org/dev/peps/pep-0009) .. [4] PEP 12, Sample reStructuredText PEP Template, Goodger, Warsaw - (http://www.python.org/peps/pep-0012.html) + (http://www.python.org/dev/peps/pep-0012) .. [5] The script referred to here is pep2html.py, which lives in the same directory in the CVS tree as the PEPs themselves. Try ``pep2html.py --help`` for details. The URL for viewing PEPs on - the web is http://www.python.org/peps/. + the web is http://www.python.org/dev/peps/. .. _patch manager: http://sourceforge.net/tracker/?group_id=5470&atid=305470