diff options
Diffstat (limited to 'quip-0001.rst')
| -rw-r--r-- | quip-0001.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/quip-0001.rst b/quip-0001.rst index 23f3e3b..650d618 100644 --- a/quip-0001.rst +++ b/quip-0001.rst @@ -23,7 +23,7 @@ provide a concise technical specification of the feature and a rationale for the feature. If this preamble seems familiar to you, then you are probably familiar with -the PEP documents maintained by the Python community. Thanks, Python! +the `PEP documents`_ maintained by the Python community. Thanks, Python! We intend QUIPs to be the primary mechanism for proposing major new features, for collecting community input on an issue, and for documenting design @@ -68,7 +68,7 @@ QUIP Format =========== QUIPs are UTF-8 encoded text files using the reStructuredText_ format. -ReStructuredText_ allows for rich markup that is still quite easy to read, but +ReStructuredText allows for rich markup that is still quite easy to read, but also results in good-looking and functional HTML. A script automatically converts QUIPs to HTML for viewing on the web [2]_. Lines should not exceed 80 characters in length. @@ -85,8 +85,7 @@ optional and are described below. All other headers are required. :: QUIP: <quip number> Title: <quip title> Author: <list of authors' real names and, optionally, email addresses> - Status: <Draft | Active | Accepted | Deferred | Rejected | - Withdrawn | Final | Superseded> + Status: <Active | Superseded | Withdrawn> Type: <Implementation | Informational | Process> * Qt-Version: <version number> * Content-Type: text/x-rst @@ -111,6 +110,8 @@ If there are multiple authors, each should be on a separate line following RFC 2822 continuation line conventions. Note that personal email addresses in QUIPs will be obscured as a defense against spam harvesters. +The Status header supports a sub-graph of the python community's `PEP lifecycle`_. + The Type header specifies the type of QUIP: Implementation, Informational, or Process. @@ -152,6 +153,8 @@ file extension (e.g. "png"). The descriptive shortname is optional. References and Footnotes ======================== +.. _`PEP documents`: https://www.python.org/dev/peps/ + .. [1] This historical record is available by the normal git commands for retrieving older revisions, and can also be browsed via HTTP here: https://code.qt.io/cgit/meta/quips.git/ @@ -162,3 +165,5 @@ References and Footnotes .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _RFC-822: https://www.ietf.org/rfc/rfc0822.txt + +.. _`PEP lifecycle`: https://www.python.org/dev/peps/pep-0001/#pep-review-resolution |