Skip to content

Conversation

@woodruffw
Copy link
Member

@woodruffw woodruffw commented Feb 10, 2025

This follows #1803 and #1808, as part of my effort to make the living index specification a bit easier to follow. Key changes:

  1. I've removed the Rename dist-info-metadata in the Simple API section 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.
  2. I've updated both the HTML and JSON sections to mention 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/

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @woodruffw

@willingc willingc added this pull request to the merge queue Feb 14, 2025
Merged via the queue into pypa:main with commit c9b8cb6 Feb 14, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants