PEP 9 (plaintext PEPs) is deprecated.
This commit is contained in:
parent
544e54168a
commit
39ffb20dc3
23
pep-0001.txt
23
pep-0001.txt
|
@ -340,22 +340,15 @@ Each PEP should have the following parts:
|
|||
PEP Formats and Templates
|
||||
=========================
|
||||
|
||||
There are two PEP formats available to authors: plaintext and
|
||||
reStructuredText_. Both are UTF-8-encoded text files.
|
||||
PEPs are UTF-8 encoded text files using the reStructuredText_ format.
|
||||
ReStructuredText_ allows for rich markup that is still quite easy to
|
||||
read, but also results in good-looking and functional HTML. PEP 12
|
||||
contains instructions and a template [4]_ for reStructuredText PEPs.
|
||||
|
||||
Plaintext PEPs are written with minimal structural markup that adheres
|
||||
to a rigid style. PEP 9 contains a instructions and a template [3]_
|
||||
you can use to get started writing your plaintext PEP.
|
||||
|
||||
ReStructuredText_ PEPs allow for rich markup that is still quite easy
|
||||
to read, but results in much better-looking and more functional HTML.
|
||||
PEP 12 contains instructions and a template [4]_ for reStructuredText
|
||||
PEPs.
|
||||
|
||||
There is a Python script that converts both styles of PEPs to HTML for
|
||||
viewing on the web [5]_. Parsing and conversion of plaintext PEPs is
|
||||
self-contained within the script. reStructuredText PEPs are parsed
|
||||
and converted by Docutils_ code called from the script.
|
||||
A Python script automatically converts PEPs to HTML for viewing on
|
||||
the web [5]_. The conversion of reStructuredText PEPs is handled by
|
||||
the Docutils_ module; the same script also renders a legacy plain-text
|
||||
format of PEP internally, to support pre-reST documents.
|
||||
|
||||
|
||||
PEP Header Preamble
|
||||
|
|
11
pep-0009.txt
11
pep-0009.txt
|
@ -3,13 +3,22 @@ Title: Sample Plaintext PEP Template
|
|||
Version: $Revision$
|
||||
Last-Modified: $Date$
|
||||
Author: Barry Warsaw <barry@python.org>
|
||||
Status: Active
|
||||
Status: Withdrawn
|
||||
Type: Process
|
||||
Content-Type: text/plain
|
||||
Created: 14-Aug-2001
|
||||
Resolution: https://mail.python.org/mailman/private/peps/2016-January/001165.html
|
||||
Post-History:
|
||||
|
||||
|
||||
Update
|
||||
|
||||
As of 05-Jan-2016, this PEP is officially deprecated and replaced
|
||||
by PEP 12. All PEPs should now use the reStructuredText format
|
||||
described by PEP 12, and plaintext PEPs will no longer be
|
||||
accepted, however you may still see legacy PEPs written using the
|
||||
plaintext style.
|
||||
|
||||
Abstract
|
||||
|
||||
This PEP provides a boilerplate or sample template for creating
|
||||
|
|
25
pep-0012.txt
25
pep-0012.txt
|
@ -26,25 +26,19 @@ the steps below. **DO NOT USE THE HTML FILE AS YOUR TEMPLATE!**
|
|||
The source for this (or any) PEP can be found in the PEPs repository,
|
||||
viewable on the web at https://hg.python.org/peps/file/tip .
|
||||
|
||||
If you would prefer not to use markup in your PEP, please see PEP 9,
|
||||
"Sample Plaintext PEP Template" [2]_.
|
||||
|
||||
|
||||
Rationale
|
||||
=========
|
||||
|
||||
PEP submissions come in a wide variety of forms, not all adhering
|
||||
to the format guidelines set forth below. Use this template, in
|
||||
conjunction with the format guidelines below, to ensure that your
|
||||
PEP submission won't get automatically rejected because of form.
|
||||
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.
|
||||
|
||||
ReStructuredText is offered as an alternative to plaintext PEPs, to
|
||||
allow PEP authors more functionality and expressivity, while
|
||||
maintaining easy readability in the source text. The processed HTML
|
||||
form makes the functionality accessible to readers: live hyperlinks,
|
||||
styled text, tables, images, and automatic tables of contents, among
|
||||
other advantages. For an example of a PEP marked up with
|
||||
reStructuredText, see PEP 287.
|
||||
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:
|
||||
live hyperlinks, styled text, tables, images, and automatic tables of
|
||||
contents, among other advantages.
|
||||
|
||||
|
||||
How to Use This Template
|
||||
|
@ -622,9 +616,6 @@ References
|
|||
.. [1] PEP 1, PEP Purpose and Guidelines, Warsaw, Hylton
|
||||
(http://www.python.org/dev/peps/pep-0001)
|
||||
|
||||
.. [2] PEP 9, Sample Plaintext PEP Template, Warsaw
|
||||
(http://www.python.org/dev/peps/pep-0009)
|
||||
|
||||
|
||||
Copyright
|
||||
=========
|
||||
|
|
Loading…
Reference in New Issue