[Python-checkins] r43268 - peps/trunk/pep-0001.txt

[david.goodger]

Author: david.goodger
Date: Fri Mar 24 04:24:04 2006
New Revision: 43268

Modified:
   peps/trunk/pep-0001.txt
Log:
added Auxiliary Files section; updated URLs; updated text file description

Modified: peps/trunk/pep-0001.txt
==============================================================================
--- peps/trunk/pep-0001.txt	(original)
+++ peps/trunk/pep-0001.txt	Fri Mar 24 04:24:04 2006
@@ -25,9 +25,9 @@
 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 @@
 =========================
 
 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 @@
 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 @@
    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