Skip to content

PEP 1: Use plain text formatting and fix links #2259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AA-Turner merged 5 commits into from
Jan 23, 2022
Merged

PEP 1: Use plain text formatting and fix links #2259

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0a28506
PEP 1: Use plain text formatting not Python
hugovk Jan 23, 2022
0c2e2c1
PEP 1: Update link redirects and remove link to non-existent devguide…
hugovk Jan 23, 2022
7126c97
PEP 1: Re-use existing target
hugovk Jan 23, 2022
aad94a6
PEP 1: Link directly to docs to remove extra level of indirection
hugovk Jan 23, 2022
9799ad2
Remove redundant lines
hugovk Jan 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions pep-0001.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <pep number>
Title: <pep title>
Expand Down Expand Up @@ -738,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 <http://docs.python.org/devguide>`_
instructions, follow `The Python Developers Guide <https://devguide.python.org/>`_

The git repo for the peps is::
Copy link
Copy Markdown
Member

@CAM-Gerlach CAM-Gerlach Jan 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given you've updated the other links, may as well not still use a verbatim block that the user has to manually copy, paste and navigate to in their browser instead of simply a link. I suggest just deleting this block and making the change above instead to link it

Copy link
Copy Markdown
Member Author

@hugovk hugovk Jan 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, like this? cb1fdfe

Copy link
Copy Markdown
Member

@CAM-Gerlach CAM-Gerlach Jan 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I meant just deleting the whole block (couldn't make it a suggestion as it was outside the scope GitHub would let me), since the PEP repo is already referred to and directly linked two lines above, so restating that is now redundant.


Expand Down Expand Up @@ -770,15 +772,12 @@ administrative & editorial part (which is generally a low volume task).

Resources:

* `Index of Python Enhancement Proposals <http://www.python.org/dev/peps/>`_
* `Index of Python Enhancement Proposals <https://www.python.org/dev/peps/>`_

* `Following Python's Development
<http://docs.python.org/devguide/communication.html>`_

* `Python Developer's Guide <http://docs.python.org/devguide/>`_
<https://devguide.python.org/communication/>`_

* `Frequently Asked Questions for Developers
<http://docs.python.org/devguide/faq.html>`_
* `Python Developer's Guide <https://devguide.python.org/>`_


References and Footnotes
Expand All @@ -793,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

Expand Down