PEP 676: Copyedit text for clarity, grammar, readibility and meaning

Author: CAM-Gerlach

pep-0676.rst

@@ -55,9 +55,9 @@ to create a full local instance of the `python.org`_ website and run a number
 of disparate scripts, following `documentation`_ that lives outside of the
 `python/peps`_ repository.
 
-The proposed implementation provides a single `Makefile`_ and a Python script
-to render all PEP files, with options to target a web server or local
-filesystem environment.
+By contrast, the proposed implementation provides a single `Makefile`_ and a
+Python script to render all PEP files, with options to target a web server or
+the local filesystem environment.
 
 Using a single repository to host all tooling will clarify where to raise
 issues, reducing volunteer time spent in triage.
@@ -81,16 +81,17 @@ There are several requests for additional features in reading PEPs, such as:
 
 These are "easy wins" from this proposal, and would serve to improve the
 quality-of-life for consumers of PEPs (including reviewers and writers). For
-example, the reference implementation no longer requires a scheduled render
+example, the new reference implementation no longer requires a scheduled render
 process to run, instead initiating rendering on every commit to the
 `python/peps`_ repository.
 
-Equally, there are a small number of broken items, for example list styles not
-being respected or support for updating images being challenging with the
-system [7]_. These would be solved by default in the proposal.
+Equally, there are a number of broken items currently; for example, list styles
+are not respected, and support for updating images is challenging with the
+current system [7]_. These are solved by the reference implementation of
+this proposal.
 
-Commercial providers such as `Read the Docs`_ can additionally enhance this
-experience, for example by providing rendered previews of changes in pull
+Third-party providers such as `Read the Docs`_ can additionally enhance this
+experience; for example, by providing rendered previews of changes in pull
 requests.
 
 
@@ -100,17 +101,19 @@ Specification
 The proposed specification for rendering the PEP files to HTML is as per the
 `reference implementation`_.
 
-That the HTML files should be made available under ``peps.python.org``. The
-rendered files may be hosted just as static files, and behind a content
-delivery network (CDN).
+The HTML files SHOULD be made available under the ``peps.python.org`` domain.
+The rendered output SHOULD be hosted as static files, and MAY be behind a
+content delivery network (CDN).
 
-The following redirect rules must be created from the `python.org`_ domain:
+The following redirect rules MUST be created from the `python.org`_ domain:
 
 * ``/peps/``            -> https://peps.python.org/
 * ``/dev/peps/``        -> https://peps.python.org/
 * ``/peps/(.*)\.html``  -> https://peps.python.org/$1
 * ``/dev/peps/(.*)``    -> https://peps.python.org/$1
 
+The following Nginx configuration would achieve this:
+
 .. code-block:: nginx
 
     location ~ ^/dev/peps/?(.*)$ {
@@ -125,53 +128,60 @@ The following redirect rules must be created from the `python.org`_ domain:
         return 308 https://peps.python.org/;
     }
 
-Redirects must be implemented to preserve `URL fragments`_ for backward
+Redirects MUST be implemented to preserve `URL fragments`_ for backward
 compatibility purposes.
 
 
 Backwards Compatibility
 =======================
 
-Due to server-side redirects to new canonical URLs, there are no backwards
-compatibility concerns. Links in previously published materials referring to
-any old URL scheme will be guaranteed to work.
+Due to server-side redirects to new canonical URLs, links in previously
+published materials referring to the old URL scheme will be guaranteed to work.
+Furthermore, aside from the resolved bugs and new implemented features, all
+existing PEPs will still render as they did before with the new backend.
+Therefore, this poses no major backwards compatibility concerns.
 
 
 Security Implications
 =====================
 
-No security implications, and the main `python.org`_ website will no longer
-take raw HTML uploads, closing a potential threat vector.
+The main `python.org`_ website will no longer need to process raw HTML
+uploads, closing a potential threat vector, and the PEP building and
+deployment process will use modern, well maintained code and secure
+automated platforms, reducing likely potential attack surface. Therefore,
+there is no forseen negative security impact.
 
 
 How to Teach This
 =================
 
 The new canonical URLs will be publicised in the documentation. However, this
 is mainly a backend infrastructure change, and there should be minimal
-end-user impact.
+end-user impact. PEP 1 and PEP 12 will be updated as needed to include and
+document any relevant new roles, directive, syntax and other constructs enabled
+by this change.
 
 
 Reference Implementation
 ========================
 
 The proposed implementation has been merged into the `python/peps`_ repository
-in a series of pull requests [8]_. This automatically renders all PEPs on every
-commit.
+in a series of pull requests [8]_. It currently automatically renders all
+PEPs on every commit.
 
 
 Rejected Ideas
 ==============
 
-It would likely be possible to amend the current (as of November 2021)
-rendering process to include a lot of the quality-of-life improvements and
-issue mitigations mentioned above. However, we do not believe that this would
+It would likely be possible to amend the current docutils-based manual
+rendering process to include many of the quality-of-life improvements and
+bug mitigations mentioned above. However, we do not believe that this would
 solve the distributed tooling issue.
 
 It would be possible to use the output from the proposed rendering system and
-import it into `python.org`_. We would argue however that this would be the
-worst of both worlds, as a great deal of complexity is added, and none is
-removed.
+import it into the existing `python.org`_ domain. We would argue, however,
+that this would be the worst of both worlds, as a great deal of complexity
+is added, while none is removed.
 
 
 Open Issues
@@ -183,8 +193,8 @@ None.
 Acknowledgments
 ===============
 
-Thanks to Hugo van Kemenade, Pablo Galindo Salgado, and Éric Araujo for support
-since April 2020.
+Thanks to Hugo van Kemenade, Pablo Galindo Salgado and Éric Araujo for
+supporting this effort since April 2020.
 
 
 Footnotes