PEP 1/12: Clarify language around Post-History links & make anonymous

python · Mar 2, 2022 · f95e99b · f95e99b
1 parent 1e49847
commit f95e99b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/pep-0001.txt b/pep-0001.txt
@@ -600,8 +600,8 @@ optional and are described below.  All other headers are required.
   * Requires: <pep numbers>
     Created: <date created on, in dd-mmm-yyyy format>
   * Python-Version: <version number>
-    Post-History: <dates, in dd-mmm-yyyy format, and corresponding links to
-                   PEP discussion threads>
+    Post-History: <dates, in dd-mmm-yyyy format,
+                   inline-linked to PEP discussion threads>
   * Replaces: <pep number>
   * Superseded-By: <pep number>
   * Resolution: <url>
@@ -658,7 +658,8 @@ Content-Type header is present.
 
 The Created header records the date that the PEP was assigned a
 number, while Post-History is used to record the dates of and corresponding
-inline links to the Discussions-To threads for the PEP.
+URLs to the Discussions-To threads for the PEP, with the former as the
+linked text, and the latter as the link target.
 Both headers should be in dd-mmm-yyyy format, e.g. 14-Aug-2001.
 
 Standards Track PEPs will typically have a Python-Version header which

diff --git a/pep-0012.rst b/pep-0012.rst
@@ -123,14 +123,14 @@ directions below.
   to this header each time you post your PEP to the designated discussion forum
   (and update the ``Discussions-To`` header with said link, as above).
   If you posted threads for your PEP on August 14, 2001 and September 3, 2001,
-  the Post-History header would look something like:
+  the Post-History header would look like, e.g.:
 
   .. code-block:: email
 
-      Post-History: `14-Aug-2001 <https://www.example.com/thread_1>`_,
-                    `03-Sept-2001 <https://www.example.com/thread_2>`_
+      Post-History: `14-Aug-2001 <https://www.example.com/thread_1>`__,
+                    `03-Sept-2001 <https://www.example.com/thread_2>`__
 
-  You must manually add new dates/links as soon as you post a
+  You should add the new dates/links here as soon as you post a
   new discussion thread.
 
 - Add a Replaces header if your PEP obsoletes an earlier PEP.  The
@@ -173,7 +173,7 @@ your PEP):
   Requires: *[NNN]
   Created: [DD-MMM-YYYY]
   Python-Version: *[M.N]
-  Post-History: [`DD-MMM-YYYY <URL>`_]
+  Post-History: [`DD-MMM-YYYY <URL>`__]
   Replaces: *[NNN]
   Superseded-By: *[NNN]
   Resolution: