forked from python/peps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pep-0009.txt
187 lines (133 loc) · 6.86 KB
/
pep-0009.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
PEP: 9
Title: Sample PEP Template
Version: $Revision$
Last-Modified: $Date$
Author: barry@zope.com (Barry A. Warsaw)
Status: Active
Type: Informational
Created: 14-Aug-2001
Post-History:
Abstract
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].
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.
How to Use This Template for Standard Track PEPs
First, decide if your PEP is going to be Informational or
Standards Track. Most PEPs are Standards Track; if yours is, then
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.
- 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 letter month abbreviation.
- 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 after your PEP has been assigned a number and you've
posted your PEP to python-list@python.org or
python-dev@python.org.
- 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 $100k in
unmarked pennies. (Just kidding, I wanted to see if you were
still awake. :)
How to Use This Template for Informational PEPs
If your PEP is an Information PEP, 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 $100k 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/
Copyright
This document has been placed in the public domain.
Local Variables:
mode: indented-text
indent-tabs-mode: nil
End: