diff --git a/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md b/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md index 48aaa3072b7..1c4856033c3 100644 --- a/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md +++ b/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md @@ -29,8 +29,8 @@ If your PEP is not Standards Track, remove the corresponding section. * [ ] 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 * [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable) * [ ] Motivation - * [ ] Rationale * [ ] Specification + * [ ] Rationale * [ ] Backwards Compatibility * [ ] Security Implications * [ ] How to Teach This diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 739993b179a..a82877ce05c 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -509,7 +509,13 @@ Each PEP should have the following parts/sections: projects in the Python ecosystem. PEP submissions without sufficient motivation may be rejected. -4. Rationale -- The rationale fleshes out the specification by +4. Specification -- The technical specification should describe the + syntax and semantics of any new language feature. The + specification should be detailed enough to allow competing, + interoperable implementations for at least the current major Python + platforms (CPython, Jython, IronPython, PyPy). + +5. Rationale -- The rationale fleshes out the specification by describing why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. @@ -518,12 +524,6 @@ Each PEP should have the following parts/sections: community and discuss important objections or concerns raised during discussion. -5. Specification -- The technical specification should describe the - syntax and semantics of any new language feature. The - specification should be detailed enough to allow competing, - interoperable implementations for at least the current major Python - platforms (CPython, Jython, IronPython, PyPy). - 6. Backwards Compatibility -- All PEPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The PEP must explain how the diff --git a/peps/pep-0012.rst b/peps/pep-0012.rst index 377fc915db7..f2d11cb2766 100644 --- a/peps/pep-0012.rst +++ b/peps/pep-0012.rst @@ -32,13 +32,17 @@ The source for this (or any) PEP can be found in the as well as via a link at the bottom of each PEP. -Rationale -========= +Specification +============= If you intend to submit a PEP, you MUST use this template, in conjunction with the format guidelines below, to ensure that your PEP submission won't get automatically rejected because of form. + +Rationale +========= + ReStructuredText provides PEP authors with useful functionality and expressivity, while maintaining easy readability in the source text. The processed HTML form makes the functionality accessible to readers: