Skip to content

Commit 7e8ff6b

Browse files
dstufftwarsaw
andauthored
PEP 12 & 1: Move Specification before Rationale (#4802)
Move Specification before Rationale Co-authored-by: Barry Warsaw <barry@python.org>
1 parent 92f55f9 commit 7e8ff6b

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ If your PEP is not Standards Track, remove the corresponding section.
2929
* [ ] PEP topic [discussed in a suitable venue](https://peps.python.org/pep-0001/#start-with-an-idea-for-python) with general agreement that a PEP is appropriate
3030
* [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable)
3131
* [ ] Motivation
32-
* [ ] Rationale
3332
* [ ] Specification
33+
* [ ] Rationale
3434
* [ ] Backwards Compatibility
3535
* [ ] Security Implications
3636
* [ ] How to Teach This

peps/pep-0001.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,13 @@ Each PEP should have the following parts/sections:
509509
projects in the Python ecosystem. PEP submissions without
510510
sufficient motivation may be rejected.
511511

512-
4. Rationale -- The rationale fleshes out the specification by
512+
4. Specification -- The technical specification should describe the
513+
syntax and semantics of any new language feature. The
514+
specification should be detailed enough to allow competing,
515+
interoperable implementations for at least the current major Python
516+
platforms (CPython, Jython, IronPython, PyPy).
517+
518+
5. Rationale -- The rationale fleshes out the specification by
513519
describing why particular design decisions were made. It should
514520
describe alternate designs that were considered and related work,
515521
e.g. how the feature is supported in other languages.
@@ -518,12 +524,6 @@ Each PEP should have the following parts/sections:
518524
community and discuss important objections or concerns raised
519525
during discussion.
520526

521-
5. Specification -- The technical specification should describe the
522-
syntax and semantics of any new language feature. The
523-
specification should be detailed enough to allow competing,
524-
interoperable implementations for at least the current major Python
525-
platforms (CPython, Jython, IronPython, PyPy).
526-
527527
6. Backwards Compatibility -- All PEPs that introduce backwards
528528
incompatibilities must include a section describing these
529529
incompatibilities and their severity. The PEP must explain how the

peps/pep-0012.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ The source for this (or any) PEP can be found in the
3232
as well as via a link at the bottom of each PEP.
3333

3434

35-
Rationale
36-
=========
35+
Specification
36+
=============
3737

3838
If you intend to submit a PEP, you MUST use this template, in
3939
conjunction with the format guidelines below, to ensure that your PEP
4040
submission won't get automatically rejected because of form.
4141

42+
43+
Rationale
44+
=========
45+
4246
ReStructuredText provides PEP authors with useful functionality and
4347
expressivity, while maintaining easy readability in the source text.
4448
The processed HTML form makes the functionality accessible to readers:

0 commit comments

Comments
 (0)