iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PEP 1: Update outdated language referring to Travis CI and plain-text PEPs (#2347) 

* PEP 1: Update outdated language referring to Travis CI

* Further revise PEP 1 CI wording based on reviewer suggestions
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
CAM Gerlach 2022-02-21 12:58:30 -06:00 committed by GitHub
parent 0cac70c4d0
commit 2ff27508fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
pep-0001.txt
View File

@ -204,10 +204,10 @@ The standard PEP workflow is:
editors do not consider whether they seem likely to be accepted. editors do not consider whether they seem likely to be accepted.
* The title accurately describes the content. * The title accurately describes the content.
* The PEP's language (spelling, grammar, sentence structure, etc.) * The PEP's language (spelling, grammar, sentence structure, etc.)
and code style (examples should match :pep:`8` & :pep:`7`) should be and code style (examples should match :pep:`7` & :pep:`8`) should be
correct and conformant. The PEP will be checked for formatting correct and conformant. The PEP text will be automatically checked for
(plain text or reStructuredText) by Travis CI, and will not be correct reStructuredText formatting when the pull request is submitted.
approved until this passes. PEPs with invalid reST markup will not be approved.
Editors are generally quite lenient about this initial review, Editors are generally quite lenient about this initial review,
expecting that problems will be corrected by the reviewing process. expecting that problems will be corrected by the reviewing process.
@ -520,7 +520,7 @@ PEP Formats and Templates
========================= =========================
PEPs are UTF-8 encoded text files using the reStructuredText_ format. PEPs are UTF-8 encoded text files using the reStructuredText_ format.
ReStructuredText_ allows for rich markup that is still quite easy to reStructuredText allows for rich markup that is still quite easy to
read, but also results in good-looking and functional HTML. :pep:`12` read, but also results in good-looking and functional HTML. :pep:`12`
contains instructions and a :pep:`template <12#suggested-sections>` contains instructions and a :pep:`template <12#suggested-sections>`
for reStructuredText PEPs. for reStructuredText PEPs.
@ -602,11 +602,11 @@ Discussions-To header will not be obscured.
The Type header specifies the type of PEP: Standards Track, The Type header specifies the type of PEP: Standards Track,
Informational, or Process. Informational, or Process.
The format of a PEP is specified with a Content-Type header. The The format of a PEP is specified with a Content-Type header.
acceptable values are "text/plain" for plaintext PEPs (see :pep:`9`) Valid values are ``text/plain`` for plaintext PEPs (see :pep:`9`)
and "text/x-rst" for reStructuredText PEPs (see :pep:`12`). and ``text/x-rst`` for reStructuredText PEPs (see :pep:`12`).
reStructuredText is strongly preferred, but for backwards All new and active PEPs must use reStructuredText, but for backwards
compatibility plain text is currently still the default if no compatibility, plain text is currently still the default if no
Content-Type header is present. Content-Type header is present.
The Created header records the date that the PEP was assigned a The Created header records the date that the PEP was assigned a
@ -718,8 +718,8 @@ For each new PEP that comes in an editor does the following:
* Skim the PEP for obvious defects in language (spelling, grammar, * Skim the PEP for obvious defects in language (spelling, grammar,
sentence structure, etc.), and code style (examples should conform to sentence structure, etc.), and code style (examples should conform to
:pep:`8` & :pep:`7`). Editors may correct problems themselves, but are :pep:`7` & :pep:`8`). Editors may correct problems themselves, but are
not required to do so. (Text format is checked by Travis CI.) not required to do so (reStructuredText syntax is checked by the repo's CI).
* If a project is portrayed as benefiting from or supporting the PEP, make sure * If a project is portrayed as benefiting from or supporting the PEP, make sure
there is some direct indication from the project included to make the support there is some direct indication from the project included to make the support