PEP 629: Fix and clarify wording, add BDFL-Delegate header (#1530)
This commit is contained in:
parent
769d7789e5
commit
97354461ac
21
pep-0629.rst
21
pep-0629.rst
|
@ -1,6 +1,7 @@
|
||||||
PEP: 629
|
PEP: 629
|
||||||
Title: Versioning PyPI's Simple API
|
Title: Versioning PyPI's Simple API
|
||||||
Author: Donald Stufft <donald@stufft.io>
|
Author: Donald Stufft <donald@stufft.io>
|
||||||
|
BDFL-Delegate: Donald Stufft <donald@stufft.io>
|
||||||
Discussions-To: https://discuss.python.org/t/pep-629-versioning-pypis-simple-api/4720
|
Discussions-To: https://discuss.python.org/t/pep-629-versioning-pypis-simple-api/4720
|
||||||
Status: Draft
|
Status: Draft
|
||||||
Type: Standards Track
|
Type: Standards Track
|
||||||
|
@ -53,12 +54,20 @@ This would end up looking like::
|
||||||
|
|
||||||
<meta name="pypi:repository-version" content="1.0">
|
<meta name="pypi:repository-version" content="1.0">
|
||||||
|
|
||||||
Interpretation of this version is that incrementing the major version
|
When interpreting the repository version:
|
||||||
is considereed a backwards incompatible change such that existing
|
|
||||||
clients would no longer be expected to be able to meaningfully use the
|
* Incrementing the major version is used to signal a backwards
|
||||||
new API, and incrementing the minor version is a backwards compatible
|
incompatible change such that existing clients would no longer be
|
||||||
change that existing clients would no longer be able to meaningfully
|
expected to be able to meaningfully use the API.
|
||||||
use the API.
|
* Incrementing the minor version is used to signal a backwards
|
||||||
|
compatible change such that existing clients would still be
|
||||||
|
expected to be able to meaningfully use the API.
|
||||||
|
|
||||||
|
It is left up to the discretion of any future PEPs as to what
|
||||||
|
specifically constitutes a backwards incompatible vs compatible change
|
||||||
|
beyond the broad suggestion that existing clients will be able to
|
||||||
|
"meaningfully" continue to use the API, and can include adding,
|
||||||
|
modifying, or removing existing features.
|
||||||
|
|
||||||
It is expectation of this PEP that the major version will never be
|
It is expectation of this PEP that the major version will never be
|
||||||
incremented, and any future major API evolutions would utilize a
|
incremented, and any future major API evolutions would utilize a
|
||||||
|
|
Loading…
Reference in New Issue