8000 Make PEP 9 one massive literal block (#437) · python/peps@7bd9f7c · GitHub
[go: up one dir, main page]
Skip to content

Commit 7bd9f7c

Browse files
brettcannonbrettcannon
authored
Make PEP 9 one massive literal block (#437)
Closes #4.
1 parent a1214f0 commit 7bd9f7c

File tree

1 file changed

+161
-162
lines changed

1 file changed

+161
-162
lines changed

‎pep-0009.txt

Lines changed: 161 additions & 162 deletions
Original file line numberDiff line numberDiff line change
@@ -5,225 +5,224 @@ Last-Modified: $Date$
55
Author: Barry Warsaw <barry@python.org>
66
Status: Withdrawn
77
Type: Process
8-
Content-Type: text/plain
8+
Content-Type: text/x-rst
99
Created: 14-Aug-2001
1010
Post-History:
1111
Resolution: https://mail.python.org/mailman/private/peps/2016-January/001165.html
1212

13+
::
14+
Update
1315

14-
Update
16+
As of 05-Jan-2016, this PEP is officially deprecated and replaced
17+
by PEP 12. All PEPs should now use the reStructuredText format
18+
described by PEP 12, and plaintext PEPs will no longer be
19+
accepted.
1520

16-
As of 05-Jan-2016, this PEP is officially deprecated and replaced
17-
by PEP 12. All PEPs should now use the reStructuredText format
18-
described by PEP 12, and plaintext PEPs will no longer be
19-
accepted, however you may still see legacy PEPs written using the
20-
plaintext style.
21+
Abstract
2122

22-
Abstract
23+
This PEP provides a boilerplate or sample template for creating
24+
your own plaintext PEPs. In conjunction with the content
25+
guidelines in PEP 1 [1], this should make it easy for you to
26+
conform your own PEPs to the format outlined below.
2327

24-
This PEP provides a boilerplate or sample template for creating
25-
your own plaintext PEPs. In conjunction with the content
26-
guidelines in PEP 1 [1], this should make it easy for you to
27-
conform your own PEPs to the format outlined below.
28+
Note: if you are reading this PEP via the web, you should first
29+
grab the plaintext source of this PEP in order to complete the
30+
steps below. DO NOT USE THE HTML FILE AS YOUR TEMPLATE!
2831

29-
Note: if you are reading this PEP via the web, you should first
30-
grab the plaintext source of this PEP in order to complete the
31-
steps below. DO NOT USE THE HTML FILE AS YOUR TEMPLATE!
32+
To get the source this (or any) PEP, look at the top of the HTML
33+
page and click on the date & time on the "Last-Modified" line. It
34+
is a link to the source text in the Python repository.
3235

33-
To get the source this (or any) PEP, look at the top of the HTML
34-
page and click on the date & time on the "Last-Modified" line. It
35-
is a link to the source text in the Python repository.
36+
If you would prefer to use lightweight markup in your PEP, please
37+
see PEP 12, "Sample reStructuredText PEP Template" [2].
3638

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

40+
Rationale
4041

41-
Rationale
42+
PEP submissions come in a wide variety of forms, not all adhering
43+
to the format guidelines set forth below. Use this template, in
44+
conjunction with the content guidelines in PEP 1, to ensure that
45+
your PEP submission won't get automatically rejected because of
46+
form.
4247

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

49+
How to Use This Template
4950

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

52-
To use this template you must first decide whether your PEP is
53-
going to be an Informational or Standards Track PEP. Most PEPs
54-
are Standards Track because they propose a new feature for the
55-
Python language or standard library. When in doubt, read PEP 1
56-
for details or contact the PEP editors <peps@python.org>.
57+
Once you've decided which type of PEP yours is going to be, follow
58+
the directions below.
5759

58-
Once you've decided which type of PEP yours is going to be, follow
59-
the directions below.
60+
- Make a copy of this file (.txt file, not HTML!) and perform the
61+
following edits.
6062

61-
- Make a copy of this file (.txt file, not HTML!) and perform the
62-
following edits.
63+
- Replace the "PEP: 9" header with "PEP: XXX" since you don't yet
64+
have a PEP number assignment.
6365

64-
- Replace the "PEP: 9" header with "PEP: XXX" since you don't yet
65-
have a PEP number assignment.
66+
- Change the Title header to the title of your PEP.
6667

67-
- Change the Title header to the title of your PEP.
68+
- Leave the Version and Last-Modified headers alone; we'll take
69+
care of those when we check your PEP into Python's Subversion
70+
repository. These headers consist of keywords ("Revision" and
71+
"Date" enclosed in "$"-signs) which are automatically expanded
72+
by the repository. Please do not edit the expanded date or
73+
revision text.
6874

69-
- Leave the Version and Last-Modified headers alone; we'll take
70-
care of those when we check your PEP into Python's Subversion
71-
repository. These headers consist of keywords ("Revision" and
72-
"Date" enclosed in "$"-signs) which are automatically expanded
73-
by the repository. Please do not edit the expanded date or
74-
revision text.
75+
- Change the Author header to include your name, and optionally
76+
your email address. Be sure to follow the format carefully:
77+
your name must appear first, and it must not be contained in
78+
parentheses. Your email address may appear second (or it can be
79+
omitted) and if it appears, it must appear in angle brackets.
80+
It is okay to obfuscate your email address.
7581

76-
- Change the Author header to include your name, and optionally
77-
your email address. Be sure to follow the format carefully:
78-
your name must appear first, and it must not be contained in
79-
parentheses. Your email address may appear second (or it can be
80-
omitted) and if it appears, it must appear in angle brackets.
81-
It is okay to obfuscate your email address.
82+
- If there is a mailing list for discussion of your new feature,
83+
add a Discussions-To header right after the Author header. You
84+
should not add a Discussions-To header if the mailing list to be
85+
used is either python-list@python.org or python-dev@python.org,
86+
or if discussions should be sent to you directly. Most
87+
Informational PEPs don't have a Discussions-To header.
88+
89+
- Change the Status header to "Draft".
90+
91+
- For Standards Track PEPs, change the Type header to "Standards
92+
Track".
93+
94+
- For Informational PEPs, change the Type header to
95+
"Informational".
96+
97+
- For Standards Track PEPs, if your feature depends on the
98+
acceptance of some other currently in-development PEP, add a
99+
Requires header right after the Type header. The value should
100+
be the PEP number of the PEP yours depends on. Don't add this
101+
header if your dependent feature is described in a Final PEP.
82102

83-
- If there is a mailing list for discussion of your new feature,
84-
add a Discussions-To header right after the Author header. You
85-
should not add a Discussions-To header if the mailing list to be
86-
used is either python-list@python.org or python-dev@python.org,
87-
or if discussions should be sent to you directly. Most
88-
Informational PEPs don't have a Discussions-To header.
103+
- Change the Created header to today's date. Be sure to follow
104+
the format carefully: it must be in dd-mmm-yyyy format, where
105+
the mmm is the 3 English letter month abbreviation, e.g. one of
106+
Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
89107

90-
- Change the Status header to "Draft".
91-
92-
- For Standards Track PEPs, change the Type header to "Standards
93-
Track".
108+
- For Standards Track PEPs, after the Created header, add a
109+
Python-Version header and set the value to the next planned
110+
version of Python, i.e. the one your new feature will hopefully
111+
make its first appearance in. Do not use an alpha or beta
112+
release designation here. Thus, if the last version of Python
113+
was 2.2 alpha 1 and you're hoping to get your new feature into
114+
Python 2.2, set the header to:
94115

95-
- For Informational PEPs, change the Type header to
96-
"Informational".
116+
Python-Version: 2.2
97117

98-
- For Standards Track PEPs, if your feature depends on the
99-
acceptance of some other currently in-development PEP, add a
100-
Requires header right after the Type header. The value should
101-
be the PEP number of the PEP yours depends on. Don't add this
102-
header if your dependent feature is described in a Final PEP.
118+
- Leave Post-History alone for now; you'll add dates to this
119+
header each time you post your PEP to python-list@python.org or
120+
python-dev@python.org. E.g. if you posted your PEP to the lists
121+
on August 14, 2001 and September 3, 2001, the Post-History
122+
header would look like:
103123

104-
- Change the Created header to today's date. Be sure to follow
105-
the format carefully: it must be in dd-mmm-yyyy format, where
106-
the mmm is the 3 English letter month abbreviation, e.g. one of
107-
Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
124+
Post-History: 14-Aug-2001, 03-Sept-2001
108125

109-
- For Standards Track PEPs, after the Created header, add a
110-
Python-Version header and set the value to the next planned
111-
version of Python, i.e. the one your new feature will hopefully
112-
make its first appearance in. Do not use an alpha or beta
113-
release designation here. Thus, if the last version of Python
114-
was 2.2 alpha 1 and you're hoping to get your new feature into
115-
Python 2.2, set the header to:
126+
You must manually add new dates and check them in. If you don't
127+
have check-in privileges, send your changes to the PEP editor.
116128

117-
Python-Version: 2.2
129+
- Add a Replaces header if your PEP obsoletes an earlier PEP. The
130+
value of this header is the number of the PEP that your new PEP
131+
is replacing. Only add this header if the older PEP is in
132+
"final" form, i.e. is either Accepted, Final, or Rejected. You
133+
aren't replacing an older open PEP if you're submitting a
134+
competing idea.
118135

119-
- Leave Post-History alone for now; you'll add dates to this
120-
header each time you post your PEP to python-list@python.org or
121-
python-dev@python.org. E.g. if you posted your PEP to the lists
122-
on August 14, 2001 and September 3, 2001, the Post-History
123-
header would look like:
136+
- Now write your Abstract, Rationale, and other content for your
137+
PEP, replacing all this gobbledygook with your own text. Be sure
138+
to adhere to the format guidelines below, specifically on the
139+
prohibition of tab characters and the indentation requirements.
124140

125-
Post-History: 14-Aug-2001, 03-Sept-2001
141+
- Update your References and Copyright section. Usually you'll
142+
place your PEP into the public domain, in which case just leave
143+
the "Copyright" section alone. Alternatively, you can use the
144+
Open Publication License[3], but public domain is still strongly
145+
preferred.
126146

127-
You must manually add new dates and check them in. If you don't
128-
have check-in privileges, send your changes to the PEP editor.
147+
- Leave the little Emacs turd at the end of this file alone,
148+
including the formfeed character ("^L", or \f).
129149

130-
- Add a Replaces header if your PEP obsoletes an earlier PEP. The
131-
value of this header is the number of the PEP that your new PEP
132-
is replacing. Only add this header if the older PEP is in
133-
"final" form, i.e. is either Accepted, Final, or Rejected. You
134-
aren't replacing an older open PEP if you're submitting a
135-
competing idea.
150+
- Send your PEP submission to the PEP editors (peps@python.org),
151+
along with $100k in unmarked pennies. (Just kidding, I wanted
152+
to see if you were still awake. :)
136153

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

142-
- Update your References and Copyright section. Usually you'll
143-
place your PEP into the public domain, in which case just leave
144-
the "Copyright" section alone. Alternatively, you can use the
145-
Open Publication License[3], but public domain is still strongly
146-
preferred.
155+
Plaintext PEP Formatting Requirements
147156

148-
- Leave the little Emacs turd at the end of this file alone,
149-
including the formfeed character ("^L", or \f).
157+
PEP headings must begin in column zero and the initial letter of
158+
each word must be capitalized as in book titles. Acronyms should
159+
be in all capitals. The body of each section must be indented 4
160+
spaces. Code samples inside body sections should be indented a
161+
further 4 spaces, and other indentation can be used as required to
162+
make the text readable. You must use two blank lines between the
163+
last line of a section's body and the next section heading.
150164

151-
- Send your PEP submission to the PEP editors (peps@python.org),
152-
along with $100k in unmarked pennies. (Just kidding, I wanted
153-
to see if you were still awake. :)
165+
You must adhere to the Emacs convention of adding two spaces at
166+
the end of every sentence. You should fill your paragraphs to
167+
column 70, but under no circumstances should your lines extend
168+
past column 79. If your code samples spill over column 79, you
169+
should rewrite them.
154170

171+
Tab characters must never appear in the document at all. A PEP
172+
should include the standard Emacs stanza included by example at
173+
the bottom of this PEP.
155174

156-
Plaintext PEP Formatting Requirements
175+
When referencing an external web page in the body of a PEP, you
176+
should include the title of the page in the text, with a
177+
footnote reference to the URL. Do not include the URL in the body
178+
text of the PEP. E.g.
157179

158-
PEP headings must begin in column zero and the initial letter of
159-
each word must be capitalized as in book titles. Acronyms should
160-
be in all capitals. The body of each section must be indented 4
161-
spaces. Code samples inside body sections should be indented a
162-
further 4 spaces, and other indentation can be used as required to
163-
make the text readable. You must use two blank lines between the
164-
last line of a section's body and the next section heading.
180+
Refer to the Python Language web site [1] for more details.
181+
...
182+
[1] http://www.python.org
165183

166-
You must adhere to the Emacs convention of adding two spaces at
167-
the end of every sentence. You should fill your paragraphs to
168-
column 70, but under no circumstances should your lines extend
169-
past column 79. If your code samples spill over column 79, you
170-
should rewrite them.
184+
When referring to another PEP, include the PEP number in the body
185+
text, such as "PEP 1". The title may optionally appear. Add a
186+
footnote reference, a number in square brackets. The footnote
187+
body should include the PEP's title and author. It may optionally
188+
include the explicit URL on a separate line, but only in the
189+
References section. Note that the pep2html.py script will
190+
calculate URLs automatically. For example:
171191

172-
Tab characters must never appear in the document at all. A PEP
173-
should include the standard Emacs stanza included by example at
174-
the bottom of this PEP.
192+
...
193+
Refer to PEP 1 [7] for more information about PEP style
194+
...
175195

176-
When referencing an external web page in the body of a PEP, you
177-
should include the title of the page in the text, with a
178-
footnote reference to the URL. Do not include the URL in the body
179-
text of the PEP. E.g.
196+
References
180197

181-
Refer to the Python Language web site [1] for more details.
182-
...
183-
[1] http://www.python.org
198+
[7] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
199+
http://www.python.org/dev/peps/pep-0001/
184200

185-
When referring to another PEP, include the PEP number in the body
186-
text, such as "PEP 1". The title may optionally appear. Add a
187-
footnote reference, a number in square brackets. The footnote
188-
body should include the PEP's title and author. It may optionally
189-
include the explicit URL on a separate line, but only in the
190-
References section. Note that the pep2html.py script will
191-
calculate URLs automatically. For example:
201+
If you decide to provide an explicit URL for a PEP, please use
202+
this as the URL template:
192203

193-
...
194-
Refer to PEP 1 [7] for more information about PEP style
195-
...
204+
http://www.python.org/dev/peps/pep-xxxx/
196205

197-
References
206+
PEP numbers in URLs must be padded with zeros from the left, so as
207+
to be exactly 4 characters wide, however PEP numbers in the text
208+
are never padded.
198209

199-
[7] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
200-
http://www.python.org/dev/peps/pep-0001/
201210

202-
If you decide to provide an explicit URL for a PEP, please use
203-
this as the URL template:
211+
References
204212

205-
http://www.python.org/dev/peps/pep-xxxx/
213+
[1] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
214+
http://www.python.org/dev/peps/pep-0001/
206215

207-
PEP numbers in URLs must be padded with zeros from the left, so as
208-
to be exactly 4 characters wide, however PEP numbers in the text
209-
are never padded.
216+
[2] PEP 12, Sample reStructuredText PEP Template, Goodger, Warsaw
217+
http://www.python.org/dev/peps/pep-0012/
210218

219+
[3] http://www.opencontent.org/openpub/
211220

212-
References
213221

214-
[1] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
215-
http://www.python.org/dev/peps/pep-0001/
216222

217-
[2] PEP 12, Sample reStructuredText PEP Template, Goodger, Warsaw
218-
http://www.python.org/dev/peps/pep-0012/
223+
Copyright
219224

220-
[3] http://www.opencontent.org/openpub/
221-
222-
223-
224-
Copyright
225-
226-
This document has been placed in the public domain.
225+
This document has been placed in the public domain.
227226

228227

229228

0 commit comments

Comments
 (0)
0