simple-repository-api: clean up PEP 658/PEP 714 bits #1810
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This follows #1803 and #1808, as part of my effort to make the living index specification a bit easier to follow. Key changes:
Rename dist-info-metadata in the Simple APIsection entirely, which seems to have come mostly verbatim from PEP 714. Instead, I've folded its prescriptions (renaming fields in both the HTML and JSON representations) into their relevant sections.data-core-metadata/core-metadata, and have added admonitions noting that the old (PEP 658) names are considered legacy.While doing the above, I noticed a minor errata (maybe even too small to be an errata?): PEP 658 and PEP 714 both change the Index APIs and happened after version 1.0 but before 1.1. Consequently, there was no version bump defined for either, despite the fact that they change fields in a forward compatible way (which other PEPs mark by bumping the minor version).
In practice the above doesn't matter (since everything is compatible), but it means that PEP 658 and PEP 714 don't fit cleanly into the "API Version History" section.
CC @di @pypa/packaging-user-guide-editors
📚 Documentation preview 📚: https://python-packaging-user-guide--1810.org.readthedocs.build/en/1810/