8000 PEP 1/12: Clarify language around Post-History links & make anonymous · python/peps@f95e99b · GitHub
[go: up one dir, main page]

Skip to content

Commit f95e99b

Browse files
committed
PEP 1/12: Clarify language around Post-History links & make anonymous
1 parent 1e49847 commit f95e99b

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

pep-0001.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -600,8 +600,8 @@ optional and are described below. All other headers are required.
600600
* Requires: <pep numbers>
601601
Created: <date created on, in dd-mmm-yyyy format>
602602
* Python-Version: <version number>
603-
Post-History: <dates, in dd-mmm-yyyy format, and corresponding links to
604-
PEP discussion threads>
603+
Post-History: <dates, in dd-mmm-yyyy format,
604+
inline-linked to PEP discussion threads>
605605
* Replaces: <pep number>
606606
* Superseded-By: <pep number>
607607
* Resolution: <url>
@@ -658,7 +658,8 @@ Content-Type header is present.
658658

659659
The Created header records the date that the PEP was assigned a
660660
number, while Post-History is used to record the dates of and corresponding
661-
inline links to the Discussions-To threads for the PEP.
661+
URLs to the Discussions-To threads for the PEP, with the former as the
662+
linked text, and the latter as the link target.
662663
Both headers should be in dd-mmm-yyyy format, e.g. 14-Aug-2001.
663664

664665
Standards Track PEPs will typically have a Python-Version header which

pep-0012.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,14 @@ directions below.
123123
to this header each time you post your PEP to the designated discussion forum
124124
(and update the ``Discussions-To`` header with said link, as above).
125125
If you posted threads for your PEP on August 14, 2001 and September 3, 2001,
126-
the Post-History header would look something like:
126+
the Post-History header would look like, e.g.:
127127

128128
.. code-block:: email
129129
130-
Post-History: `14-Aug-2001 <https://www.example.com/thread_1>`_,
131-
`03-Sept-2001 <https://www.example.com/thread_2>`_
130+
Post-History: `14-Aug-2001 <https://www.example.com/thread_1>`__,
131+
`03-Sept-2001 <https://www.example.com/thread_2>`__
132132
133-
You must manually add new dates/links as soon as you post a
133+
You should add the new dates/links here as soon as you post a
134134
new discussion thread.
135135

136136
- Add a Replaces header if your PEP obsoletes an earlier PEP. The
@@ -173,7 +173,7 @@ your PEP):
173173
Requires: *[NNN]
174174
Created: [DD-MMM-YYYY]
175175
Python-Version: *[M.N]
176-
Post-History: [`DD-MMM-YYYY <URL>`_]
176+
Post-History: [`DD-MMM-YYYY <URL>`__]
177177
Replaces: *[NNN]
178178
Superseded-By: *[NNN]
179179
Resolution:

0 commit comments

Comments
 (0)
0