Skip to content

Commit c0f078d

Browse files
committed
Consistent changelogs for all specs
Fixes #1203
1 parent 83fc010 commit c0f078d

15 files changed

+105
-57
lines changed

source/specifications/binary-distribution-format.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -418,12 +418,9 @@ Is it possible to import Python code directly from a wheel file?
418418
History
419419
=======
420420

421-
This specification was originally approved as :pep:`427`.
422-
423-
The following changes were applied since the initial version:
424-
425-
- The rules on escaping in wheel filenames were revised, to bring them
426-
into line with what popular tools actually do (February 2021).
421+
- February 2013: This specification was approved through :pep:`427`.
422+
- February 2021: The rules on escaping in wheel filenames were revised, to bring
423+
them into line with what popular tools actually do.
427424

428425

429426
Appendix

source/specifications/core-metadata.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -848,6 +848,26 @@ Example::
848848
Obsoletes: Gorgon
849849

850850

851+
History
852+
=======
853+
854+
- March 2001: Core metadata 1.0 was approved through :pep:`241`.
855+
- April 2003: Core metadata 1.1 was approved through :pep:`314`:
856+
- February 2010: Core metadata 1.2 was approved through :pep:`345`.
857+
- February 2018: Core metadata 2.1 was approved through :pep:`566`.
858+
859+
- Added ``Description-Content-Type`` and ``Provides-Extra``.
860+
- Added canonical method for transforming metadata to JSON.
861+
- Restricted the grammar of the ``Name`` field.
862+
863+
- October 2020: Core metadata 2.2 was approved through :pep:`643`.
864+
865+
- Added the ``Dynamic`` field.
866+
867+
- March 2022: Core metadata 2.3 was approved through :pep:`685`.
868+
869+
- Restricted extra names to be normalized.
870+
851871
----
852872

853873
.. [1] reStructuredText markup:

source/specifications/dependency-specifiers.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -472,14 +472,12 @@ A test program - if the grammar is in a string ``grammar``:
472472
print("%s -> %s" % (test, parsed))
473473
474474
475-
Summary of changes to PEP 508
476-
=============================
475+
History
476+
=======
477477

478-
The following changes were made based on feedback after its initial
479-
implementation:
480-
481-
- The definition of ``python_version`` was changed from
482-
``platform.python_version()[:3]`` to
478+
- November 2015: This specification was approved through :pep:`508`.
479+
- July 2019: The definition of ``python_version`` was `changed
480+
<python-version-change_>`_ from ``platform.python_version()[:3]`` to
483481
``'.'.join(platform.python_version_tuple()[:2])``, to accommodate potential
484482
future versions of Python with 2-digit major and minor versions
485483
(e.g. 3.10). [#future_versions]_
@@ -497,3 +495,7 @@ References
497495
.. [#future_versions] Future Python versions might be problematic with the
498496
definition of Environment Marker Variable ``python_version``
499497
(https://github.com/python/peps/issues/560)
498+
499+
500+
501+
.. _python-version-change: https://mail.python.org/pipermail/distutils-sig/2018-January/031920.html

source/specifications/direct-url-data-structure.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -262,10 +262,15 @@ Local directory in editable mode:
262262
}
263263
}
264264
265+
265266
History
266267
=======
267268

268-
- March 2020: this data structure was originally specified as part of the
269-
``direct_url.json`` metadata file in :pep:`610` and is formally documented here.
270-
- January 2023: Added the ``archive_info.hashes`` key
271-
([discussion](https://discuss.python.org/t/22299)).
269+
- March 2020: This specification was approved through :pep:`610`, defining
270+
the ``direct_url.json`` metadata file.
271+
- January 2023: Added the ``archive_info.hashes`` key (`discussion
272+
<archive-info-hashes_>`_).
273+
274+
275+
276+
.. _archive-info-hashes: https://discuss.python.org/t/22299

source/specifications/direct-url.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ Commands that *do not* generate a ``direct_url.json``
6262
* ``pip install app``
6363
* ``pip install app --no-index --find-links https://example.com/``
6464

65+
6566
History
6667
=======
6768

68-
- March 2020: the ``direct_url.json`` metadata file was originally specified in
69-
:pep:`610` and is formally documented here.
69+
- March 2020: This specification was approved through :pep:`610`.

source/specifications/entry-points.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,14 @@ which defines where command-line tools are found.
158158
As files are created from the names, and some filesystems are case-insensitive,
159159
packages should avoid using names in these groups which differ only in case.
160160
The behaviour of install tools when names differ only in case is undefined.
161+
162+
163+
History
164+
=======
165+
166+
- October 2017: This specification was written to formalize the existing
167+
entry points feature of setuptools (discussion_).
168+
169+
170+
171+
.. _discussion: https://mail.python.org/pipermail/distutils-sig/2017-October/031585.html

source/specifications/externally-managed-environments.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,4 +471,4 @@ CC0-1.0-Universal license, whichever is more permissive.
471471
History
472472
=======
473473

474-
This specification was originally approved as :pep:`668`.
474+
- June 2022: This specification was approved through :pep:`668`.

source/specifications/inline-script-metadata.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,4 +238,4 @@ the highest available version of Python that is compatible with the script's
238238
History
239239
=======
240240

241-
This specification was originally defined as :pep:`723`.
241+
- October 2023: This specification was conditionally approved through :pep:`723`.

source/specifications/name-normalization.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,7 @@ This means that the following names are all equivalent:
4141
History
4242
=======
4343

44-
- `September 2015 <https://mail.python.org/pipermail/distutils-sig/2015-September/026899.html>`_: normalized name was originally specified in :pep:`503#normalized-names`.
45-
- `November 2015 <https://mail.python.org/pipermail/distutils-sig/2015-November/027868.html>`_: valid non-normalized name was originally specified in :pep:`508#names`.
44+
- September 2015: The specification of name normalized was approved through
45+
:pep:`503 <503#normalized-names>`.
46+
- November 2015: The specification of valid names was approved through
47+
:pep:`508 <508#names>`.

source/specifications/platform-compatibility-tags.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,6 @@ Platform compatibility tags allow build tools to mark distributions as being
99
compatible with specific platforms, and allows installers to understand which
1010
distributions are compatible with the system they are running on.
1111

12-
The following PEPs contributed to this spec:
13-
14-
1. :pep:`425`
15-
2. :pep:`513`
16-
3. :pep:`571`
17-
4. :pep:`599`
18-
5. :pep:`600`
1912

2013
Overview
2114
========
@@ -302,3 +295,15 @@ Why is the ABI tag (the second tag) sometimes "none" in the reference implementa
302295
implementation at the time of writing guesses "none". Ideally it
303296
would detect "py27(d|m|u)" analogous to newer versions of Python,
304297
but in the meantime "none" is a good enough way to say "don't know".
298+
299+
300+
History
301+
=======
302+
303+
- February 2013: The original version of this specification was approved through
304+
:pep:`425`.
305+
- January 2016: The ``manylinux1`` tag was approved through :pep:`513`.
306+
- April 2018: The ``manylinux2010`` tag was approved through :pep:`571`.
307+
- July 2019: The ``manylinux2014`` tag was approved through :pep:`599`.
308+
- November 2019: The ``manylinux_x_y`` perennial tag was approved through
309+
:pep:`600`.

source/specifications/pyproject-toml.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -441,8 +441,12 @@ the subtable ``tool.$NAME`` if, and only if, they own the entry for
441441
History
442442
=======
443443

444-
This specification was originally defined in :pep:`518` (``[build-system]``
445-
and ``[tool]`` tables) and :pep:`621` (``[project]`` table).
444+
- May 2016: The initial specification of the ``pyproject.toml`` file, with just
445+
a ``[build-system]`` containing a ``requires`` key and a ``[tool]`` table, was
446+
approved through :pep:`518`.
447+
448+
- November 2020: The specification of the ``[project]`` table was approved
449+
through :pep:`621`.
446450

447451

448452

source/specifications/recording-installed-packages.rst

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,6 @@ files in a format specific to Python tooling, it should still record the name
1919
and version of the installed project.
2020

2121

22-
History and change workflow
23-
===========================
24-
25-
The metadata described here was first specified in :pep:`376`, and later
26-
amended in :pep:`627` (and other PEPs).
27-
It was formerly known as *Database of Installed Python Distributions*.
28-
As with other PyPA specifications, editorial amendments with no functional
29-
impact may be made through the GitHub pull request workflow. Proposals for
30-
functional changes that would require amendments to package building and/or
31-
installation tools must be made through the PEP process (see :pep:`1`).
32-
33-
While this document is the normative specification, the PEPs that introduce
34-
changes to it may include additional information such as rationales and
35-
backwards compatibility considerations.
36-
37-
3822
The .dist-info directory
3923
========================
4024

@@ -262,3 +246,16 @@ ensuring both locations appear on the default Python import path).
262246
In some circumstances, it may be desirable to block even installation of
263247
additional packages via Python-specific tools. For these cases refer to
264248
:ref:`externally-managed-environments`
249+
250+
251+
History
252+
=======
253+
254+
- June 2009: The original version of this specification was approved through
255+
:pep:`376`. At the time, it was known as the *Database of Installed Python
256+
Distributions*.
257+
- March 2020: The specification of the ``direct_url.json`` file was approved
258+
through :pep:`610`. It is only mentioned on this page; see :ref:`direct-url`
259+
for the full definition.
260+
- September 2020: Various amendments and clarifications were approved through
261+
:pep:`627`.

source/specifications/source-distribution-format.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,10 @@ verification* in ``tarfile`` documentation apply to their tool.
143143
History
144144
=======
145145

146-
* August 2023: Standardized the source distribution archive features (:pep:`721`)
147-
* September 2022: Standardized the filename of a source distribution (:pep:`625`)
148-
* July 2021: Defined what a source tree is
149-
* November 2020: :pep:`643` converted to this specification
150-
* December 2000: Source distributions standardized in :pep:`643`
146+
* November 2020: The original version of this specification was approved through
147+
:pep:`643`.
148+
* July 2021: Defined what a source tree is.
149+
* September 2022: The filename of a source distribution was standardized through
150+
:pep:`625`.
151+
* August 2023: Source distribution archive features were standardized through
152+
:pep:`721`.

source/specifications/version-specifiers.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1261,7 +1261,4 @@ project):
12611261
History
12621262
=======
12631263

1264-
This specification was originally approved as :pep:`440`,
1265-
addressing several limitations of the previous attempt
1266-
at standardized versioning, as described in :pep:`345`
1267-
and :pep:`386`.
1264+
- August 2014: This specification was approved through :pep:`440`.

source/specifications/virtual-environments.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,9 @@ Even in the absence of a ``pyvenv.cfg`` file, any approach (e.g.
4848
``sys.prefix`` and ``sys.base_prefix`` having different values, while still
4949
providing a matching default package installation scheme in ``sysconfig``, will
5050
be detected and behave as a Python virtual environment.
51+
52+
53+
History
54+
=======
55+
56+
- May 2012: This specification was approved through :pep:`405`.

0 commit comments

Comments
 (0)