Skip to content

Conversation

@woodruffw
Copy link
Member

@woodruffw woodruffw commented Feb 6, 2025

This follows #1803, and performs a few cleanup actions on the simple repository API docs:

  • I've removed the Additional Fields for the Simple API for Package Indexes section entirely and have folded its prose into the relevant parts of the JSON Serialization section. This makes the doc as a whole easier to follow, since the user doesn't need to tab down to a different adjacent section to learn about the changes made with API version 1.1. It's also consistent with that was done with API version 1.3, i.e. PEP 740.
  • I've added an API Version History subsection that lists only API versions and the PEPs that stabilized them. This should make it easier to cross-reference changes.
  • I've moved the standard RFC 2119 language to the top of the document, since the entire doc uses it and not just the subsection it previously was in.
  • I've added a few instances of proper HTML syntax highlighting.

CC @di @brettcannon @nlhkabu


📚 Documentation preview 📚: https://python-packaging-user-guide--1808.org.readthedocs.build/en/1808/

@di di requested a review from a team February 6, 2025 19:19
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.

@woodruffw Thanks for these helpful changes. The prose and rendering look good to me.

@willingc willingc added this pull request to the merge queue Feb 10, 2025
Merged via the queue into pypa:main with commit fbe05df Feb 10, 2025
8 checks passed
@woodruffw woodruffw deleted the ww/cleanup-simple-api branch February 10, 2025 13:44
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.

4 participants