From 0a28506e3dc95cab43036fdfe435dc87b59fb97c Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 23 Jan 2022 14:52:34 +0200 Subject: [PATCH 1/5] PEP 1: Use plain text formatting not Python --- pep-0001.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pep-0001.txt b/pep-0001.txt index ffdda84092f..42276592153 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -530,7 +530,9 @@ PEP Header Preamble Each PEP must begin with an :rfc:`2822` style header preamble. The headers must appear in the following order. Headers marked with "*" are -optional and are described below. All other headers are required. :: +optional and are described below. All other headers are required. + +.. code-block:: text PEP: Title: From 0c2e2c195aa4c093baa63c359bbddaaadd051a49 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 23 Jan 2022 14:53:14 +0200 Subject: [PATCH 2/5] PEP 1: Update link redirects and remove link to non-existent devguide FAQ --- pep-0001.txt | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/pep-0001.txt b/pep-0001.txt index 42276592153..25e747e8090 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -740,7 +740,7 @@ Once the PEP is ready for the repository, a PEP editor will: status as "Draft". * Add the PEP to a local fork of the PEP repository. For workflow - instructions, follow `The Python Developers Guide `_ + instructions, follow `The Python Developers Guide `_ The git repo for the peps is:: @@ -772,15 +772,12 @@ administrative & editorial part (which is generally a low volume task). Resources: -* `Index of Python Enhancement Proposals `_ +* `Index of Python Enhancement Proposals `_ * `Following Python's Development - `_ + `_ -* `Python Developer's Guide `_ - -* `Frequently Asked Questions for Developers - `_ +* `Python Developer's Guide `_ References and Footnotes @@ -795,16 +792,16 @@ References and Footnotes https://github.com/python/peps/blob/main/README.rst .. [3] `CODEOWNERS` documentation - (https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) + (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) .. _issue tracker: - http://bugs.python.org/ + https://bugs.python.org/ .. _CC0-1.0-Universal: https://choosealicense.com/licenses/cc0-1.0/ -.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _reStructuredText: https://docutils.sourceforge.io/rst.html -.. _Docutils: http://docutils.sourceforge.net/ +.. _Docutils: https://docutils.sourceforge.io/ .. _PEP repository: https://github.com/python/peps From 7126c975b0d25678977441010182d414082d5e80 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 23 Jan 2022 21:31:51 +0200 Subject: [PATCH 3/5] PEP 1: Re-use existing target Co-authored-by: CAM Gerlach --- pep-0001.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pep-0001.txt b/pep-0001.txt index 25e747e8090..7c85a5b4ef9 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -739,7 +739,7 @@ Once the PEP is ready for the repository, a PEP editor will: ("Standards Track", "Informational", or "Process"), and marked its status as "Draft". -* Add the PEP to a local fork of the PEP repository. For workflow +* Add the PEP to a local fork of the `PEP repository`_. For workflow instructions, follow `The Python Developers Guide `_ The git repo for the peps is:: From aad94a630a9b2cc07d97efe8669a49962a25eb56 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 23 Jan 2022 21:39:21 +0200 Subject: [PATCH 4/5] PEP 1: Link directly to docs to remove extra level of indirection --- pep-0001.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pep-0001.txt b/pep-0001.txt index 7c85a5b4ef9..77367106cd3 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -188,7 +188,7 @@ The standard PEP workflow is: "Informational", or "Process" as appropriate, and for the "Status:" field enter "Draft". For full details, see `PEP Header Preamble`_. -* Update `.github/CODEOWNERS` [3]_ such that any co-author(s) or sponsors +* Update `.github/CODEOWNERS`_ such that any co-author(s) or sponsors with write access to the `PEP repository`_ are listed for your new file. This ensures any future pull requests changing the file will be assigned to them. @@ -710,7 +710,7 @@ For each new PEP that comes in an editor does the following: * The file name extension is correct (i.e. ``.rst``). * Ensure that everyone listed as a sponsor or co-author of the PEP who has write - access to the `PEP repository`_ is added to `.github/CODEOWNERS` [3]_. + access to the `PEP repository`_ is added to `.github/CODEOWNERS`_. * Skim the PEP for obvious defects in language (spelling, grammar, sentence structure, etc.), and code style (examples should conform to @@ -791,8 +791,8 @@ References and Footnotes in the PEPs repo README at https://github.com/python/peps/blob/main/README.rst -.. [3] `CODEOWNERS` documentation - (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) +.. _.github/CODEOWNERS: + https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners .. _issue tracker: https://bugs.python.org/ From 9799ad2033a57c0d9b8ba21280a3e6fbffedf9cf Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 23 Jan 2022 23:03:43 +0200 Subject: [PATCH 5/5] Remove redundant lines --- pep-0001.txt | 4 ---- 1 file changed, 4 deletions(-) diff --git a/pep-0001.txt b/pep-0001.txt index 77367106cd3..92b4694356b 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -742,10 +742,6 @@ Once the PEP is ready for the repository, a PEP editor will: * Add the PEP to a local fork of the `PEP repository`_. For workflow instructions, follow `The Python Developers Guide `_ - The git repo for the peps is:: - - https://github.com/python/peps - * Run ``./genpepindex.py`` and ``./pep2html.py `` to ensure they are generated without errors. If either triggers errors, then the web site will not be updated to reflect the PEP changes.