Skip to content

Commit

Permalink
PEP 1: Clarify that reST is the default & no plaintext PEPs remain
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach committed Feb 22, 2022
1 parent 64de899 commit 3aa9d67
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
14 changes: 6 additions & 8 deletions pep-0001.txt
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ The standard PEP workflow is:
* The title accurately describes the content.
* The PEP's language (spelling, grammar, sentence structure, etc.)
and code style (examples should match :pep:`7` & :pep:`8`) should be
correct and conformant. The PEP text will be automatically checked for
correct reStructuredText formatting when the pull request is submitted.
correct and conformant. The PEP text will be automatically checked for
correct reStructuredText formatting when the pull request is submitted.
PEPs with invalid reST markup will not be approved.

Editors are generally quite lenient about this initial review,
Expand Down Expand Up @@ -547,7 +547,7 @@ optional and are described below. All other headers are required.
Status: <Draft | Active | Accepted | Provisional | Deferred | Rejected |
Withdrawn | Final | Superseded>
Type: <Standards Track | Informational | Process>
* Content-Type: <text/x-rst | text/plain>
* Content-Type: text/x-rst
* Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format>
* Python-Version: <version number>
Expand Down Expand Up @@ -603,11 +603,9 @@ The Type header specifies the type of PEP: Standards Track,
Informational, or Process.

The format of a PEP is specified with a Content-Type header.
Valid values are ``text/plain`` for plaintext PEPs (see :pep:`9`)
and ``text/x-rst`` for reStructuredText PEPs (see :pep:`12`).
All new and active PEPs must use reStructuredText, but for backwards
compatibility, plain text is currently still the default if no
Content-Type header is present.
All PEPs now use reStructuredText (see :pep:`12`),
and have a value of ``text/x-rst``, the default.
Previously, plaintext PEPs used ``text/plain`` (see :pep:`9`).

The Created header records the date that the PEP was assigned a
number, while Post-History is used to record the dates of when new
Expand Down
1 change: 1 addition & 0 deletions pep-0012/pep-NNNN.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ 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>
Content-Type: text/x-rst
Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format>
Python-Version: <version number>
Expand Down

0 comments on commit 3aa9d67

Please sign in to comment.