Skip to content

docs: backfill API version directives#1123

Open
terminalchai wants to merge 1 commit into
pypa:mainfrom
terminalchai:docs/backfill-version-directives
Open

docs: backfill API version directives#1123
terminalchai wants to merge 1 commit into
pypa:mainfrom
terminalchai:docs/backfill-version-directives

Conversation

@terminalchai
Copy link
Copy Markdown

Summary

  • backfill missing version directives in the metadata API reference
  • document when the iOS and Android tag helpers were added
  • mark the licenses and pylock API reference pages with their introduction versions

Validation

  • d:/project_contribution/.venv/Scripts/python.exe -m nox -s tests-3.11 docs
  • d:/project_contribution/.venv/Scripts/python.exe -m nox -s lint (hits an existing all-files mypy failure in src/packaging/_manylinux.py under the current toolchain)
  • .nox/lint/Scripts/prek.exe run --files docs/metadata.rst docs/tags.rst docs/licenses.rst docs/pylock.rst

Refs #597

Comment thread docs/metadata.rst
.. autoclass:: packaging.metadata.InvalidMetadata
:members:

.. versionadded:: 23.2
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Don't we normally put this in the docstring? (could be / probably is done both ways, not a blocker if so).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yep, we do.

Copy link
Copy Markdown
Member

@brettcannon brettcannon left a comment

Choose a reason for hiding this comment

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

For the autodoc bits, please put the directive in the docstring.

Comment thread docs/metadata.rst
.. autoclass:: packaging.metadata.InvalidMetadata
:members:

.. versionadded:: 23.2
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yep, we do.

@henryiii henryiii mentioned this pull request Apr 7, 2026
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