PEP 12: provide templates for the header and sections (#913)
This commit is contained in:
parent
28d6119f0c
commit
8e7b03ab1d
112
pep-0012.rst
112
pep-0012.rst
|
@ -134,6 +134,7 @@ directions below.
|
||||||
replacing all this gobbledygook with your own text. Be sure to
|
replacing all this gobbledygook with your own text. Be sure to
|
||||||
adhere to the format guidelines below, specifically on the
|
adhere to the format guidelines below, specifically on the
|
||||||
prohibition of tab characters and the indentation requirements.
|
prohibition of tab characters and the indentation requirements.
|
||||||
|
See "Suggested Sections" below for a template of sections to include.
|
||||||
|
|
||||||
- Update your References and Copyright section. Usually you'll place
|
- Update your References and Copyright section. Usually you'll place
|
||||||
your PEP into the public domain, in which case just leave the
|
your PEP into the public domain, in which case just leave the
|
||||||
|
@ -148,6 +149,28 @@ directions below.
|
||||||
|
|
||||||
- Send your PEP submission to the PEP editors at peps@python.org.
|
- Send your PEP submission to the PEP editors at peps@python.org.
|
||||||
|
|
||||||
|
For reference, here are all of the possible header fields (everything
|
||||||
|
in brackets should either be replaced or have the field removed if
|
||||||
|
it has a leading `*` marking it as optional and it does not apply to
|
||||||
|
your PEP)::
|
||||||
|
|
||||||
|
PEP: [NNN]
|
||||||
|
Title: [...]
|
||||||
|
Author: [Full Name <email at example.com>]
|
||||||
|
Sponsor: *[Full Name <email at example.com>]
|
||||||
|
BDFL-Delegate:
|
||||||
|
Discussions-To: *[...]
|
||||||
|
Status: Draft
|
||||||
|
Type: [Standards Track | Informational | Process]
|
||||||
|
Content-Type: text/x-rst
|
||||||
|
Requires: *[NNN]
|
||||||
|
Created: [YYY-MM-DD]
|
||||||
|
Python-Version: [M.N]
|
||||||
|
Post-History: [YYYY-MM-DD]
|
||||||
|
Replaces: *[NNN]
|
||||||
|
Superceded-By: *[NNN]
|
||||||
|
Resolution:
|
||||||
|
|
||||||
|
|
||||||
ReStructuredText PEP Formatting Requirements
|
ReStructuredText PEP Formatting Requirements
|
||||||
============================================
|
============================================
|
||||||
|
@ -580,6 +603,95 @@ should be avoided. For ordinary text, use ordinary 'single-quotes' or
|
||||||
above), use double-backquotes::
|
above), use double-backquotes::
|
||||||
|
|
||||||
``literal text: in here, anything goes!``
|
``literal text: in here, anything goes!``
|
||||||
|
|
||||||
|
|
||||||
|
Suggested Sections
|
||||||
|
==================
|
||||||
|
Various sections are found to be common across PEPs and are outlined in
|
||||||
|
PEP 1 [1]_. Those sections are provided here for convenience.
|
||||||
|
::
|
||||||
|
|
||||||
|
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 has been placed in the public domain.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
..
|
||||||
|
Local Variables:
|
||||||
|
mode: indented-text
|
||||||
|
indent-tabs-mode: nil
|
||||||
|
sentence-end-double-space: t
|
||||||
|
fill-column: 70
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|
||||||
|
|
||||||
Resources
|
Resources
|
||||||
|
|
Loading…
Reference in New Issue