Skip to content

Commit 6263951

Browse files
CAM-Gerlachhugovk
andcommitted
PEP 676: Apply reviewer suggestions to revert and refine textual tweaks
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent 03c9c6b commit 6263951

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

pep-0676.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Abstract
1414
========
1515

1616
This PEP addresses the infrastructure around rendering PEP files from
17-
`reStructuredText`_ files to HTML web pages. We aim to specify a self-contained
17+
`reStructuredText`_ files to HTML webpages. We aim to specify a self-contained
1818
and maintainable solution for PEP readers, authors, and editors.
1919

2020

2121
Motivation
2222
==========
2323

2424
As of November 2021, Python Enhancement Proposals (PEPs) are rendered in a
25-
multi-system, multi-stage process. A Continuous Integration (CI) task runs a
25+
multi-system, multi-stage process. A continuous integration (CI) task runs a
2626
`docutils`_ script to render all PEP files individually. The CI task then
27-
uploads a TAR to a server, where it is retrieved and rendered into the
27+
uploads a tar archive to a server, where it is retrieved and rendered into the
2828
`python.org`_ website periodically.
2929

3030
This places a constraint on the `python.org`_ website to handle raw HTML
@@ -39,8 +39,8 @@ would:
3939
* solve a number of outstanding issues, and lay the path for improvements
4040
* save volunteer maintainers' time
4141

42-
We propose that PEPs are accessed through ``peps.python.org`` at the top-level
43-
namespace (for example, ``peps.python.org/pep-0008/``), and that all custom
42+
We propose that PEPs are accessed through `peps.python.org`_ as the top-level
43+
namespace (for example, `peps.python.org/pep-0008`_), and that all custom
4444
tooling to support rendering PEPs is hosted in the `python/peps`_ repository.
4545

4646

@@ -101,11 +101,11 @@ Specification
101101
The proposed specification for rendering the PEP files to HTML is as per the
102102
`reference implementation`_.
103103

104-
The HTML files SHOULD be made available under the ``peps.python.org`` domain.
104+
The HTML files SHOULD be made available under the `peps.python.org`_ domain.
105105
The rendered output SHOULD be hosted as static files, and MAY be behind a
106106
content delivery network (CDN).
107107

108-
The following redirect rules MUST be created from the `python.org`_ domain:
108+
The following redirect rules MUST be created for the `python.org`_ domain:
109109

110110
* ``/peps/`` -> https://peps.python.org/
111111
* ``/dev/peps/`` -> https://peps.python.org/
@@ -148,7 +148,7 @@ Security Implications
148148
The main `python.org`_ website will no longer need to process raw HTML
149149
uploads, closing a potential threat vector, and the PEP building and
150150
deployment process will use modern, well maintained code and secure
151-
automated platforms, reducing likely potential attack surface. Therefore,
151+
automated platforms, reducing the likely potential attack surface. Therefore,
152152
there is no forseen negative security impact.
153153

154154

@@ -204,6 +204,8 @@ Footnotes
204204
.. _docutils: https://docutils.sourceforge.io
205205
.. _Makefile: https://www.gnu.org/software/make/manual/make.html#Introduction
206206
.. _python.org: https://www.python.org
207+
.. _peps.python.org: https://peps.python.org/
208+
.. _peps.python.org/pep-0008: https://peps.python.org/pep-0008/
207209
.. _python/peps: https://github.com/python/peps
208210
.. _Read the Docs: https://readthedocs.org
209211
.. _reStructuredText: https://docutils.sourceforge.io/rst.html

0 commit comments

Comments
 (0)