PEP 12: create a complete PEP template (#2181)
This commit is contained in:
Brett Cannon
GitHub
parent
91b9f68579
commit
cd1e507dd8
|
|
@ -526,7 +526,7 @@ optional and are described below. All other headers are required. ::
|
|||
Author: <list of authors' real names and optionally, email addrs>
|
||||
* Sponsor: <real name of sponsor>
|
||||
* PEP-Delegate: <PEP delegate's real name>
|
||||
* Discussions-To: <email address>
|
||||
* Discussions-To: <email address or URL>
|
||||
Status: <Draft | Active | Accepted | Provisional | Deferred | Rejected |
|
||||
Withdrawn | Final | Superseded>
|
||||
Type: <Standards Track | Informational | Process>
|
||||
|
|
|
|||
89
pep-0012.rst
89
pep-0012.rst
|
|
@ -11,7 +11,8 @@ Post-History: 30-Aug-2002
|
|||
|
||||
|
||||
.. note::
|
||||
For those who have written a PEP before, there is a template_.
|
||||
For those who have written a PEP before, there is a template_
|
||||
(which is included as a file in the PEPs repository).
|
||||
|
||||
Abstract
|
||||
========
|
||||
|
|
@ -614,90 +615,8 @@ PEP 1 [1]_. Those sections are provided here for convenience.
|
|||
|
||||
.. _template:
|
||||
|
||||
::
|
||||
|
||||
Abstract
|
||||
========
|
||||
|
||||
[A short (~200 word) description of the technical issue being addressed.]
|
||||
|
||||
|
||||
Motivation
|
||||
==========
|
||||
|
||||
[Clearly explain why the existing language specification is inadequate to address the problem that the PEP solves.]
|
||||
|
||||
|
||||
Rationale
|
||||
=========
|
||||
|
||||
[Describe why particular design decisions were made.]
|
||||
|
||||
|
||||
Specification
|
||||
=============
|
||||
|
||||
[Describe the syntax and semantics of any new language feature.]
|
||||
|
||||
|
||||
Backwards Compatibility
|
||||
=======================
|
||||
|
||||
[Describe potential impact and severity on pre-existing code.]
|
||||
|
||||
|
||||
Security Implications
|
||||
=====================
|
||||
|
||||
[How could a malicious user take advantage of this new feature?]
|
||||
|
||||
|
||||
How to Teach This
|
||||
=================
|
||||
|
||||
[How to teach users, new and experienced, how to apply the PEP to their work.]
|
||||
|
||||
|
||||
Reference Implementation
|
||||
========================
|
||||
|
||||
[Link to any existing implementation and details about its state, e.g. proof-of-concept.]
|
||||
|
||||
|
||||
Rejected Ideas
|
||||
==============
|
||||
|
||||
[Why certain ideas that were brought while discussing this PEP were not ultimately pursued.]
|
||||
|
||||
|
||||
Open Issues
|
||||
===========
|
||||
|
||||
[Any points that are still being decided/discussed.]
|
||||
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
[A collection of URLs used as references through the PEP.]
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
This document is placed in the public domain or under the
|
||||
CC0-1.0-Universal license, whichever is more permissive.
|
||||
|
||||
|
||||
|
||||
..
|
||||
Local Variables:
|
||||
mode: indented-text
|
||||
indent-tabs-mode: nil
|
||||
sentence-end-double-space: t
|
||||
fill-column: 70
|
||||
coding: utf-8
|
||||
End:
|
||||
.. _include:: pep-0012/pep-NNNN.rst
|
||||
:literal:
|
||||
|
||||
|
||||
Resources
|
||||
|
|
|
|||
|
|
@ -0,0 +1,99 @@
|
|||
PEP: <REQUIRED: pep number>
|
||||
Title: <REQUIRED: pep title>
|
||||
Author: <REQUIRED: list of authors' real names and optionally, email addrs>
|
||||
Sponsor: <real name of sponsor>
|
||||
PEP-Delegate: <PEP delegate's real name>
|
||||
Discussions-To: <email address or URL>
|
||||
Status: <REQUIRED: Draft | Active | Accepted | Provisional | Deferred | Rejected | Withdrawn | Final | Superseded>
|
||||
Type: <REQUIRED: Standards Track | Informational | Process>
|
||||
Requires: <pep numbers>
|
||||
Created: <date created on, in dd-mmm-yyyy format>
|
||||
Python-Version: <version number>
|
||||
Post-History: <REQUIRED: dates of postings to python-ideas and/or python-dev, in dd-mmm-yyyy format>
|
||||
Replaces: <pep number>
|
||||
Superseded-By: <pep number>
|
||||
Resolution: <url>
|
||||
|
||||
|
||||
Abstract
|
||||
========
|
||||
|
||||
[A short (~200 word) description of the technical issue being addressed.]
|
||||
|
||||
|
||||
Motivation
|
||||
==========
|
||||
|
||||
[Clearly explain why the existing language specification is inadequate to address the problem that the PEP solves.]
|
||||
|
||||
|
||||
Rationale
|
||||
=========
|
||||
|
||||
[Describe why particular design decisions were made.]
|
||||
|
||||
|
||||
Specification
|
||||
=============
|
||||
|
||||
[Describe the syntax and semantics of any new language feature.]
|
||||
|
||||
|
||||
Backwards Compatibility
|
||||
=======================
|
||||
|
||||
[Describe potential impact and severity on pre-existing code.]
|
||||
|
||||
|
||||
Security Implications
|
||||
=====================
|
||||
|
||||
[How could a malicious user take advantage of this new feature?]
|
||||
|
||||
|
||||
How to Teach This
|
||||
=================
|
||||
|
||||
[How to teach users, new and experienced, how to apply the PEP to their work.]
|
||||
|
||||
|
||||
Reference Implementation
|
||||
========================
|
||||
|
||||
[Link to any existing implementation and details about its state, e.g. proof-of-concept.]
|
||||
|
||||
|
||||
Rejected Ideas
|
||||
==============
|
||||
|
||||
[Why certain ideas that were brought while discussing this PEP were not ultimately pursued.]
|
||||
|
||||
|
||||
Open Issues
|
||||
===========
|
||||
|
||||
[Any points that are still being decided/discussed.]
|
||||
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
[A collection of URLs used as references through the PEP.]
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
||||
This document is placed in the public domain or under the
|
||||
CC0-1.0-Universal license, whichever is more permissive.
|
||||
|
||||
|
||||
|
||||
..
|
||||
Local Variables:
|
||||
mode: indented-text
|
||||
indent-tabs-mode: nil
|
||||
sentence-end-double-space: t
|
||||
fill-column: 70
|
||||
coding: utf-8
|
||||
End:
|
||||
Loading…
Reference in New Issue