[Python-checkins] CVS: python/nondist/peps pep-0001.txt,1.26,1.27

2001年8月14日 16:58:11 -0700

Update of /cvsroot/python/python/nondist/peps
In directory usw-pr-cvs1:/tmp/cvs-serv17924
Modified Files:
	pep-0001.txt 
Log Message:
Clarify some style points, such as fill column, double-spacing at the
end of sentences, etc. Add a reference to PEP 9, a new sample PEP
template.
Index: pep-0001.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0001.txt,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -d -r1.26 -r1.27
*** pep-0001.txt	2001年08月14日 22:48:14	1.26
--- pep-0001.txt	2001年08月14日 23:58:09	1.27
***************
*** 170,178 ****

! PEP Style

 PEPs are written in plain ASCII text, and should adhere to a
 rigid style. There is a Python script that parses this style and
 converts the plain text PEP to HTML for viewing on the web[5].

 Each PEP must begin with an RFC822 style header preamble. The
--- 170,180 ----

! PEP Template

 PEPs are written in plain ASCII text, and should adhere to a
 rigid style. There is a Python script that parses this style and
 converts the plain text PEP to HTML for viewing on the web[5].
+ PEP 9 contains a boilerplate[7] template you can use to get
+ started writing your PEP.

 Each PEP must begin with an RFC822 style header preamble. The
***************
*** 216,222 ****
 lists.

! Post-History: is used to record the dates of when new versions of
! the PEP are posted to python-list and/or python-dev. The should
! be in dd-mmm-yyyy format, e.g. 14-Aug-2001.

 PEPs may have a Requires: header, indicating the PEP numbers that
--- 218,225 ----
 lists.

! Created: records the date that the PEP was assigned a number,
! while Post-History: is used to record the dates of when new
! versions of the PEP are posted to python-list and/or python-dev.
! Both headers should be in dd-mmm-yyyy format, e.g. 14-Aug-2001.

 PEPs may have a Requires: header, indicating the PEP numbers that
***************
*** 229,232 ****
--- 232,238 ----
 that it rendered obsolete.

+ 
+ PEP Formatting Requirements
+ 
 PEP headings must begin in column zero and the initial letter of
 each word must be capitalized as in book titles. Acronyms should
***************
*** 237,242 ****
 last line of a section's body and the next section heading.

 Tab characters must never appear in the document at all. A PEP
! should include the Emacs stanza included by example in this PEP.

 A PEP must contain a Copyright section, and it is strongly
--- 243,255 ----
 last line of a section's body and the next section heading.

+ You must adhere to the Emacs convention of adding two spaces at
+ the end of every sentence. You should fill your paragraphs to
+ column 70, but under no circumstances should your lines extend
+ past column 79. If your code samples spill over column 79, you
+ should rewrite them.
+ 
 Tab characters must never appear in the document at all. A PEP
! should include the standard Emacs stanza included by example at
! the bottom of this PEP.

 A PEP must contain a Copyright section, and it is strongly
***************
*** 311,321 ****

 [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://python.sourceforge.net/peps/

 [6] http://sourceforge.net/tracker/?group_id=5470&atid=305470

--- 324,337 ----

 [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://python.sourceforge.net/peps/

 [6] http://sourceforge.net/tracker/?group_id=5470&atid=305470
+ 
+ [7] PEP 9, Sample PEP Template
+ http://www.python.org/peps/pep-0009.html