[Python-checkins] python/nondist/peps pep-0009.txt,1.8,1.9

2002年8月26日 09:29:34 -0700

Update of /cvsroot/python/python/nondist/peps
In directory usw-pr-cvs1:/tmp/cvs-serv18566
Modified Files:
	pep-0009.txt 
Log Message:
David Goodger writes:
* Changed name from "Sample PEP Template" to "Sample Plaintext PEP
 Template", and edited throughout to differentiate the choices:
 - Added "plaintext" where appropriate to make the context clear.
 - "Style" -> "format".
 - Referred to PEP 1 as "content guidelines", not "style" guidelines.
* Added a "Content-Type: text/plain" header to be explicit.
* Added a reference to the alternative format available in
 reStructuredText PEPs.
* Combined "How to Use This Template for Standard Track PEPs" and "How
 to Use This Template for Informational PEPs" into one "How to Use
 This Template" section. In addition to the duplication, there were
 several errors and inconsistencies between the two source sections.
 Conditionals have been added as appropriate.
* Clarified the discussion of the Replaces header as per discussions.
* Added "Plaintext PEP Formatting Requirements", moved from PEP 1's
 "PEP Formatting Requirements".
 - Removed the paragraph beginning "A PEP must contain a Copyright
 section" as redundant; already covered in "How to Use This
 Template".
 - Minor edits.
* Minor edits, including:
 - Fixed typos.
 - Removed colons from header field names (e.g., "the Author
 header").
(Some additional minor edits by Barry).
Index: pep-0009.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0009.txt,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** pep-0009.txt	30 Jul 2002 16:23:15 -0000	1.8
--- pep-0009.txt	26 Aug 2002 16:29:31 -0000	1.9
***************
*** 1,4 ****
 PEP: 9
! Title: Sample PEP Template
 Version: $Revision$
 Last-Modified: $Date$
--- 1,4 ----
 PEP: 9
! Title: Sample Plaintext PEP Template
 Version: $Revision$
 Last-Modified: $Date$
***************
*** 6,9 ****
--- 6,10 ----
 Status: Active
 Type: Informational
+ Content-Type: text/plain
 Created: 14-Aug-2001
 Post-History:
***************
*** 13,98 ****

 This PEP provides a boilerplate or sample template for creating
! your own PEPs. This should make it easy for you to conform your
! own PEPs to the style outlined in PEP 1, PEP Guidelines[1].

 Note: if you are reading this PEP via the web, you should first
! grab the plain text version in order to complete the steps below.
! DO NOT USE THE HTML FILE AS YOUR TEMPLATE!

! To get the plain text version of this file, look at the top of the
 page and click on the link titled "PEP Source".

 Rationale

 PEP submissions come in a wide variety of forms, not all adhering
! to the style guidelines set forth in PEP 1. Use this template, in
! conjunction with the prose guidelines in PEP 1, to ensure that
 your PEP submission won't get automatically rejected because of
 form.

- To use this template you must first decide whether your PEP is
- going to be Informational or Standards Track. Most PEPs are
- Standards Track because they propose a new feature for the Python
- language or standard library. When in doubt, read PEP 1 for
- details.

! Once you've decided which type of PEP yours is going to be, follow
! the directions in the appropriate section below.

! How to Use This Template for Standard Track PEPs

! - Make a copy of this file and perform the following edits.

! - replace the "PEP: 9" header with "PEP: XXX" since you don't yet
 have a PEP number assignment.

! - Change the Title: header to the title of your PEP.

! - Leave the Version: and Last-Modified: headers alone; we'll take
 care of those when we check your PEP into CVS.

! - Change the Author: header to include your name, and optionally
 your email address. Be sure to follow the format carefully:
 your name must appear first, and it must not be contained in
! parentheses. Your email address may appear second (it can also
! be omitted) and if it appears, it must appear in angle brackets.

 - If there is a mailing list for discussion of your new feature,
! add a Discussions-To: header right after the Author: header.
! You should not add a Discussions-To: header if the mailing list
! to be used is either python-list@python.org or
! python-dev@python.org, or if discussions should be sent to you
! directly.

! - Change the Status: header to "Draft".

! - Change the Type: header to "Standards Track".

! - If your feature depends on the acceptance of some other currently
! in-development PEP, add a Requires: header right after the Type:
! header. The value should be the PEP number of the PEP yours
! depends on. Don't add this header if your dependent feature is
! described in a Final PEP.

! - Change the Created: header to today's date. Be sure to follow
 the format carefully: it must be in dd-mmm-yyyy format, where
 the mmm is the 3 English letter month abbreviation, e.g. one of
 Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.

! - After the Created: header, add a Python-Version: header and set
! the value to the next planned version of Python, i.e. the one
! your new feature will hopefully make its first appearance in.
! Do not use an alpha or beta release designation here. Thus, if
! the last version of Python was 2.2 alpha 1 and you're hoping to
! get your new feature into Python 2.2, set the header to:

 Python-Version: 2.2

! - Leave Post-History: alone for now; you'll add dates to this
 header each time you post your PEP to python-list@python.org or
 python-dev@python.org. E.g. if you posted your PEP to the lists
! on August 14, 2001 and September 3, 2001, the Post-History:
 header would look like:

--- 14,110 ----

 This PEP provides a boilerplate or sample template for creating
! your own plaintext PEPs. In conjunction with the content
! guidelines in PEP 1 [1], this should make it easy for you to
! conform your own PEPs to the format outlined below.

 Note: if you are reading this PEP via the web, you should first
! grab the plaintext source of this PEP in order to complete the
! steps below. DO NOT USE THE HTML FILE AS YOUR TEMPLATE!

! To get the source this (or any) PEP, look at the top of the html
 page and click on the link titled "PEP Source".

+ If you would prefer to use lightweight markup in your PEP, please
+ see PEP 12, "Sample reStructuredText PEP Template" [2].
+ 

 Rationale

 PEP submissions come in a wide variety of forms, not all adhering
! to the format guidelines set forth below. Use this template, in
! conjunction with the content guidelines in PEP 1, to ensure that
 your PEP submission won't get automatically rejected because of
 form.

! How to Use This Template

+ To use this template you must first decide whether your PEP is
+ going to be an Informational or Standards Track PEP. Most PEPs
+ are Standards Track because they propose a new feature for the
+ Python language or standard library. When in doubt, read PEP 1
+ for details or contact the PEP editors <peps@python.org>.

! Once you've decided which type of PEP yours is going to be, follow
! the directions below.

! - Make a copy of this file (.txt file, not HTML!) and perform the
! following edits.

! - Replace the "PEP: 9" header with "PEP: XXX" since you don't yet
 have a PEP number assignment.

! - Change the Title header to the title of your PEP.

! - Leave the Version and Last-Modified headers alone; we'll take
 care of those when we check your PEP into CVS.

! - Change the Author header to include your name, and optionally
 your email address. Be sure to follow the format carefully:
 your name must appear first, and it must not be contained in
! parentheses. Your email address may appear second (or it can be
! omitted) and if it appears, it must appear in angle brackets.
! It is okay to obfuscate your email address.

 - If there is a mailing list for discussion of your new feature,
! add a Discussions-To header right after the Author header. You
! should not add a Discussions-To header if the mailing list to be
! used is either python-list@python.org or python-dev@python.org,
! or if discussions should be sent to you directly. Most
! Informational PEPs don't have a Discussions-To header.

! - Change the Status header to "Draft".

! - For Standards Track PEPs, change the Type header to "Standards
! Track".

! - For Informational PEPs, change the Type header to
! "Informational".

! - For Standards Track PEPs, if your feature depends on the
! acceptance of some other currently in-development PEP, add a
! Requires header right after the Type header. The value should
! be the PEP number of the PEP yours depends on. Don't add this
! header if your dependent feature is described in a Final PEP.
! 
! - Change the Created header to today's date. Be sure to follow
 the format carefully: it must be in dd-mmm-yyyy format, where
 the mmm is the 3 English letter month abbreviation, e.g. one of
 Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.

! - For Standards Track PEPs, after the Created header, add a
! Python-Version header and set the value to the next planned
! version of Python, i.e. the one your new feature will hopefully
! make its first appearance in. Do not use an alpha or beta
! release designation here. Thus, if the last version of Python
! was 2.2 alpha 1 and you're hoping to get your new feature into
! Python 2.2, set the header to:

 Python-Version: 2.2

! - Leave Post-History alone for now; you'll add dates to this
 header each time you post your PEP to python-list@python.org or
 python-dev@python.org. E.g. if you posted your PEP to the lists
! on August 14, 2001 and September 3, 2001, the Post-History
 header would look like:

***************
*** 102,195 ****
 have check-in privileges, send your changes to the PEP editor.

! - Add a Replaces: header if your PEP describes a feature that will
! replace a feature described in some Final PEP. Usually you
! won't need to add this header. It's also unlikely that you'll
! ever add a Replaced-By: header.

! - Now write your abstract, rationale, and other content for your
! PEP, replacing all this gobbledygook with your own text. Be
! sure to adhere to the PEP 1 style guidelines, specifically on
! the prohibition of tab characters and the indentation
! requirements.

 - Update your References and Copyright section. Usually you'll
 place your PEP into the public domain, in which case just leave
! the Copyright section alone. Alternatively, you can use the
! Open Publication License[2], but public domain is still strongly
 preferred.

 - Leave the little Emacs turd at the end of this file alone,
! including the formfeed character (^L, or \f).
! 
! - Send your PEP submission to the PEP editor, along with 100ドルk in
! unmarked pennies. (Just kidding, I wanted to see if you were
! still awake. :)
! 

! How to Use This Template for Informational PEPs

- - Make a copy of this file and perform the following edits.

! - replace the "PEP: 9" header with "PEP: XXX" since you don't yet
! have a PEP number assignment.

! - Change the Title: header to the title of your PEP.

! - Leave the Version: and Last-Modified: headers alone; we'll take
! care of those when we check your PEP into CVS.

! - Change the Author: header to include your email address and
! name. Be sure to follow the format carefully: your email
! address must appear first, and it should not be contained in
! angle brackets. Your full name should appear second and it
! should appear in parentheses.

! - If there is a mailing list for discussion of your new feature,
! add a Discussions-To: header right after the Author: header.
! You should not add a Discussions-To: header if the mailing list
! to be used is either python-list@python.org or
! python-dev@python.org, or if discussions should be sent to you
! directly. Most Information PEPs don't have a Discussions-To:
! header.

! - Change the Status: header to "Active".

! - Change the Type: header to "Informational".

! - Change the Created: header to today's date. Be sure to follow
! the format carefully: it must be in dd-mmm-yyyy format, where
! the mmm is the 3 letter month abbreviation.

! - Leave Post-History: alone for now; you'll add dates to this
! header after your PEP has been assigned a number and you've
! posted your PEP to python-list@python.org or
! python-dev@python.org.

! - Now write your abstract, rationale, and other content for your
! PEP, replacing all this gobbledygook with your own text. Be
! sure to adhere to the PEP 1 style guidelines, specifically on
! the prohibition of tab characters and the indentation
! requirements.

! - Update your References and Copyright section. Usually you'll
! place your PEP into the public domain, in which case just leave
! the Copyright section alone. Alternatively, you can use the
! Open Publication License[2], but public domain is still strongly
! preferred.

! - Leave the little Emacs turd at the end of this file alone,
! including the formfeed character (^L, or \f).

! - Send your PEP submission to the PEP editor, along with 100ドルk in
! unmarked pennies. (Just kidding, I wanted to see if you were
! still awake. :)

 References

! [1] PEP 1, PEP Purpose and Guidelines
 http://www.python.org/peps/pep-0001.html

! [2] http://www.opencontent.org/openpub/

--- 114,208 ----
 have check-in privileges, send your changes to the PEP editor.

! - Add a Replaces header if your PEP obsoletes an earlier PEP. The
! value of this header is the number of the PEP that your new PEP
! is replacing. Only add this header if the older PEP is in
! "final" form, i.e. is either Accepted, Final, or Rejected. You
! aren't replacing an older open PEP if you're submitting a
! competing idea.

! - Now write your Abstract, Rationale, and other content for your
! PEP, replacing all this gobbledygook with your own text. Be sure
! to adhere to the format guidelines below, specifically on the
! prohibition of tab characters and the indentation requirements.

 - Update your References and Copyright section. Usually you'll
 place your PEP into the public domain, in which case just leave
! the "Copyright" section alone. Alternatively, you can use the
! Open Publication License[3], but public domain is still strongly
 preferred.

 - Leave the little Emacs turd at the end of this file alone,
! including the formfeed character ("^L", or \f).

! - Send your PEP submission to the PEP editors (peps@python.org),
! along with 100ドルk in unmarked pennies. (Just kidding, I wanted
! to see if you were still awake. :)

! Plaintext 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
! be in all capitals. The body of each section must be indented 4
! spaces. Code samples inside body sections should be indented a
! further 4 spaces, and other indentation can be used as required to
! make the text readable. You must use two blank lines between the
! 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.

! When referencing an external web page in the body of a PEP, you
! 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, a number in square brackets. The footnote
! body should include 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. For example:

! ...
! 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 the text
! are never padded.

 References

! [1] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
 http://www.python.org/peps/pep-0001.html

! [2] PEP 12, Sample reStructuredText PEP Template, Goodger, Warsaw
! http://www.python.org/peps/pep-0001.html
! 
! [3] http://www.opencontent.org/openpub/