Skip to content
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.

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

PEP 1 & 12: Have Post-History link posts to preserve Discussions-To history #2358

Merged
merged 4 commits into from
Mar 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 11 additions & 9 deletions pep-0001.txt
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,8 @@ The standard PEP workflow is:
* The title accurately describes the content.
* The PEP's language (spelling, grammar, sentence structure, etc.)
and code style (examples should match :pep:`7` & :pep:`8`) should be
correct and conformant. The PEP text will be automatically checked for
correct reStructuredText formatting when the pull request is submitted.
correct and conformant. The PEP text will be automatically checked for
correct reStructuredText formatting when the pull request is submitted.
PEPs with invalid reST markup will not be approved.

Editors are generally quite lenient about this initial review,
Expand Down Expand Up @@ -286,13 +286,13 @@ the PEP Sponsor and PEP editors can advise them accordingly.
If the chosen venue is not the `Python-Dev`_ mailing list,
a brief announcement should be posted there when the draft PEP is
committed to the PEP repository and available on the PEP website,
with a link to the rendered PEP and the to canonical Discussions-To thread.
with a link to the rendered PEP and to the canonical ``Discussions-To`` thread.

If a PEP undergoes a significant re-write or other major, substantive
changes to its proposed specification, a new thread should typically be created
in the chosen venue to solicit additional feedback. If this occurs, the
``Discussions-To`` link and ``Post-History`` in the PEP must be updated to
reflect this new thread, and (if not the discussion venue) a further
``Discussions-To`` link must be updated and a new ``Post-History`` entry added
pointing to this new thread, and (if not the discussion venue) a further
announcement sent to `Python-Dev`_ containing the same information as above
and at least briefly summarizing the major changes.

Expand Down Expand Up @@ -600,7 +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 of postings to Python-Dev and/or the Discussions-To thread, in dd-mmm-yyyy format>
Post-History: <dates, in dd-mmm-yyyy format,
inline-linked to PEP discussion threads>
* Replaces: <pep number>
* Superseded-By: <pep number>
* Resolution: <url>
Expand Down Expand Up @@ -656,9 +657,10 @@ compatibility, plain text is currently still the default if no
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 when new
versions of the PEP are posted to Python-Dev and/or the Discussions-To thread.
Both headers should be in dd-mmm-yyyy format, e.g. 14-Aug-2001.
number, while Post-History is used to record the dates of and corresponding
URLs to the Discussions-To threads for the PEP, with the former as the
linked text, and the latter as the link target.
Both sets of dates should be in ``dd-mmm-yyyy`` format, e.g. ``14-Aug-2001``.

Standards Track PEPs will typically have a Python-Version header which
indicates the version of Python that the feature will be released with.
Expand Down
33 changes: 22 additions & 11 deletions pep-0012.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Status: Active
Type: Process
Content-Type: text/x-rst
Created: 05-Aug-2002
Post-History: 30-Aug-2002
Post-History: `30-Aug-2002 <https://mail.python.org/archives/list/[email protected]/thread/KX3AS7QAY26QH3WIUAEOCCNXQ4V2TGGV/>`__


.. note::
Expand Down Expand Up @@ -113,20 +113,29 @@ directions below.
first appearance in. Do not use an alpha or beta release
designation here. Thus, if the last version of Python was 2.2 alpha
1 and you're hoping to get your new feature into Python 2.2, set the
header to::
header to:

.. code-block:: email

Python-Version: 2.2

- Leave Post-History alone for now; you'll add dates to this header
each time you post your PEP to the designated discussion forum (and announce
it on Python-Dev, if needed; see the ``Discussions-To`` header above).
- Leave Post-History alone for now; you'll add dates and corresponding links
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).
For each thread, use the date (in the ``dd-mmm-yyy`` format) as the
linked text, and insert the URLs inline as anonymous reST `hyperlinks`_,
with commas in between each posting.

If you posted threads for your PEP on August 14, 2001 and September 3, 2001,
the Post-History header would look like::
the Post-History header would look like, e.g.:

Post-History: 14-Aug-2001, 03-Sept-2001
.. code-block:: email

You must manually add new dates and commit them (with a pull request
if you don't have push privileges).
Post-History: `14-Aug-2001 <https://www.example.com/thread_1>`__,
`03-Sept-2001 <https://www.example.com/thread_2>`__

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
value of this header is the number of the PEP that your new PEP is
Expand All @@ -152,7 +161,9 @@ directions below.
For reference, here are all of the possible header fields (everything
in brackets should either be replaced or have the field removed if
it has a leading ``*`` marking it as optional and it does not apply to
your PEP)::
your PEP):

.. code-block:: email

PEP: [NNN]
Title: [...]
Expand All @@ -166,7 +177,7 @@ your PEP)::
Requires: *[NNN]
Created: [DD-MMM-YYYY]
Python-Version: *[M.N]
Post-History: [DD-MMM-YYYY]
Post-History: [`DD-MMM-YYYY <URL>`__]
Replaces: *[NNN]
Superseded-By: *[NNN]
Resolution:
Expand Down
2 changes: 1 addition & 1 deletion pep-0012/pep-NNNN.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Type: <REQUIRED: Standards Track | Informational | Process>
Requires: <pep numbers>
Created: <date created on, in dd-mmm-yyyy format>
Python-Version: <version number>
Post-History: <REQUIRED: dates of postings to Python-Dev and/or the Discussions-To thread, in dd-mmm-yyyy format>
Post-History: <REQUIRED: dates, in dd-mmm-yyyy format, and corresponding links to PEP discussion threads>
Replaces: <pep number>
Superseded-By: <pep number>
Resolution: <url>
Expand Down