PEP 629: Fix and clarify wording, add BDFL-Delegate header (#1530)

This commit is contained in:
Donald Stufft 2020-07-17 15:15:47 -04:00 committed by GitHub
parent 769d7789e5
commit 97354461ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 6 deletions

View File

@ -1,6 +1,7 @@
PEP: 629
Title: Versioning PyPI's Simple API
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
Status: Draft
Type: Standards Track
@ -53,12 +54,20 @@ This would end up looking like::
<meta name="pypi:repository-version" content="1.0">
Interpretation of this version is that incrementing the major version
is considereed a backwards incompatible change such that existing
clients would no longer be expected to be able to meaningfully use the
new API, and incrementing the minor version is a backwards compatible
change that existing clients would no longer be able to meaningfully
use the API.
When interpreting the repository version:
* Incrementing the major version is used to signal a backwards
incompatible change such that existing clients would no longer be
expected to be able to meaningfully 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
incremented, and any future major API evolutions would utilize a