PEP 1 and 12: Remove optional Content-Type from templates (#3454)

This commit is contained in:
Hugo van Kemenade 2023-09-27 19:00:23 -06:00 committed by GitHub
parent b794468df6
commit 3b5f6f4464
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 3 additions and 23 deletions

View File

@ -109,14 +109,14 @@ repos:
- id: check-required-headers - id: check-required-headers
name: "PEPs must have all required headers" name: "PEPs must have all required headers"
language: pygrep language: pygrep
entry: '(?-m:^PEP:(?=[\s\S]*\nTitle:)(?=[\s\S]*\nAuthor:)(?=[\s\S]*\nStatus:)(?=[\s\S]*\nType:)(?=[\s\S]*\nContent-Type:)(?=[\s\S]*\nCreated:))' entry: '(?-m:^PEP:(?=[\s\S]*\nTitle:)(?=[\s\S]*\nAuthor:)(?=[\s\S]*\nStatus:)(?=[\s\S]*\nType:)(?=[\s\S]*\nCreated:))'
args: ['--negate', '--multiline'] args: ['--negate', '--multiline']
files: '^peps/pep-\d+\.rst$' files: '^peps/pep-\d+\.rst$'
- id: check-header-order - id: check-header-order
name: "PEP header order must follow PEP 12" name: "PEP header order must follow PEP 12"
language: pygrep language: pygrep
entry: '^PEP:[^\n]+\nTitle:[^\n]+\n(Version:[^\n]+\n)?(Last-Modified:[^\n]+\n)?Author:[^\n]+\n( +\S[^\n]+\n)*(Sponsor:[^\n]+\n)?((PEP|BDFL)-Delegate:[^\n]*\n)?(Discussions-To:[^\n]*\n)?Status:[^\n]+\nType:[^\n]+\n(Topic:[^\n]+\n)?Content-Type:[^\n]+\n(Requires:[^\n]+\n)?Created:[^\n]+\n(Python-Version:[^\n]*\n)?(Post-History:[^\n]*\n( +\S[^\n]*\n)*)?(Replaces:[^\n]+\n)?(Superseded-By:[^\n]+\n)?(Resolution:[^\n]*\n)?\n' entry: '^PEP:[^\n]+\nTitle:[^\n]+\n(Version:[^\n]+\n)?(Last-Modified:[^\n]+\n)?Author:[^\n]+\n( +\S[^\n]+\n)*(Sponsor:[^\n]+\n)?((PEP|BDFL)-Delegate:[^\n]*\n)?(Discussions-To:[^\n]*\n)?Status:[^\n]+\nType:[^\n]+\n(Topic:[^\n]+\n)?(Content-Type:[^\n]+\n)?(Requires:[^\n]+\n)?Created:[^\n]+\n(Python-Version:[^\n]*\n)?(Post-History:[^\n]*\n( +\S[^\n]*\n)*)?(Replaces:[^\n]+\n)?(Superseded-By:[^\n]+\n)?(Resolution:[^\n]*\n)?\n'
args: ['--negate', '--multiline'] args: ['--negate', '--multiline']
files: '^peps/pep-\d+\.rst$' files: '^peps/pep-\d+\.rst$'

View File

@ -3,7 +3,6 @@ Title: PEP Purpose and Guidelines
Author: Barry Warsaw, Jeremy Hylton, David Goodger, Nick Coghlan Author: Barry Warsaw, Jeremy Hylton, David Goodger, Nick Coghlan
Status: Active Status: Active
Type: Process Type: Process
Content-Type: text/x-rst
Created: 13-Jun-2000 Created: 13-Jun-2000
Post-History: 21-Mar-2001, 29-Jul-2002, 03-May-2003, 05-May-2012, Post-History: 21-Mar-2001, 29-Jul-2002, 03-May-2003, 05-May-2012,
07-Apr-2013 07-Apr-2013
@ -610,7 +609,6 @@ optional and are described below. All other headers are required.
Withdrawn | Final | Superseded> Withdrawn | Final | Superseded>
Type: <Standards Track | Informational | Process> Type: <Standards Track | Informational | Process>
* Topic: <Governance | Packaging | Release | Typing> * Topic: <Governance | Packaging | Release | Typing>
* Content-Type: text/x-rst
* Requires: <pep numbers> * Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format> Created: <date created on, in dd-mmm-yyyy format>
* Python-Version: <version number> * Python-Version: <version number>
@ -649,7 +647,7 @@ out.
The PEP-Delegate field is used to record the individual appointed by the The PEP-Delegate field is used to record the individual appointed by the
Steering Council to make the final decision on whether or not to approve or Steering Council to make the final decision on whether or not to approve or
reject a PEP. (The delegate's email address is currently omitted due to a reject a PEP. (The delegate's email address is currently omitted due to a
limitation in the email address masking for reStructuredText PEPs) limitation in the email address masking for reStructuredText PEPs.)
*Note: The Resolution header is required for Standards Track PEPs *Note: The Resolution header is required for Standards Track PEPs
only. It contains a URL that should point to an email message or only. It contains a URL that should point to an email message or
@ -668,11 +666,6 @@ The optional Topic header lists the special topic, if any,
the PEP belongs under. the PEP belongs under.
See the :ref:`topic-index` for the existing topics. See the :ref:`topic-index` for the existing topics.
The format of a PEP is specified with a Content-Type header.
All PEPs must 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 The Created header records the date that the PEP was assigned a
number, while Post-History is used to record the dates of and corresponding number, while Post-History is used to record the dates of and corresponding
URLs to the Discussions-To threads for the PEP, with the former as the URLs to the Discussions-To threads for the PEP, with the former as the
@ -878,13 +871,3 @@ Copyright
This document is placed in the public domain or under the This document is placed in the public domain or under the
CC0-1.0-Universal license, whichever is more permissive. 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:

View File

@ -5,7 +5,6 @@ Author: David Goodger <goodger@python.org>,
Brett Cannon <brett@python.org> Brett Cannon <brett@python.org>
Status: Active Status: Active
Type: Process Type: Process
Content-Type: text/x-rst
Created: 05-Aug-2002 Created: 05-Aug-2002
Post-History: `30-Aug-2002 <https://mail.python.org/archives/list/python-dev@python.org/thread/KX3AS7QAY26QH3WIUAEOCCNXQ4V2TGGV/>`__ Post-History: `30-Aug-2002 <https://mail.python.org/archives/list/python-dev@python.org/thread/KX3AS7QAY26QH3WIUAEOCCNXQ4V2TGGV/>`__
@ -174,7 +173,6 @@ your PEP):
Status: Draft Status: Draft
Type: [Standards Track | Informational | Process] Type: [Standards Track | Informational | Process]
Topic: *[Governance | Packaging | Release | Typing] Topic: *[Governance | Packaging | Release | Typing]
Content-Type: text/x-rst
Requires: *[NNN] Requires: *[NNN]
Created: [DD-MMM-YYYY] Created: [DD-MMM-YYYY]
Python-Version: *[M.N] Python-Version: *[M.N]

View File

@ -7,7 +7,6 @@ Discussions-To: <REQUIRED: URL of current canonical discussion thread>
Status: <REQUIRED: Draft | Active | Accepted | Provisional | Deferred | Rejected | Withdrawn | Final | Superseded> Status: <REQUIRED: Draft | Active | Accepted | Provisional | Deferred | Rejected | Withdrawn | Final | Superseded>
Type: <REQUIRED: Standards Track | Informational | Process> Type: <REQUIRED: Standards Track | Informational | Process>
Topic: <Governance | Packaging | Release | Typing> Topic: <Governance | Packaging | Release | Typing>
Content-Type: text/x-rst
Requires: <pep numbers> Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format> Created: <date created on, in dd-mmm-yyyy format>
Python-Version: <version number> Python-Version: <version number>