Skip to content

docs: add missing versionadded/versionchanged directives - #1344

Merged
henryiii merged 4 commits into
pypa:mainfrom
henryiii:docs/versionadded-audit
Jul 28, 2026
Merged

docs: add missing versionadded/versionchanged directives#1344
henryiii merged 4 commits into
pypa:mainfrom
henryiii:docs/versionadded-audit

Conversation

@henryiii

@henryiii henryiii commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Instead of adding things piecemeal (see #1343 and a lot of other small PRs), I did a sweep looking for versionadded/versionchanged based on git history. Close #597. I was hoping this would be complete, but #1331 at least is not included.

🤖 AI text below 🤖

Adds missing versionadded/versionchanged directives across the public modules, found by auditing each module against git history (git tag --contains) and the changelog.

  • metadata: Metadata/InvalidMetadata (23.2), 24.0 attribute behavior, PEP 639 fields (24.2), PEP 794 fields and RFC822 classes (26.0)
  • utils: everything back to canonicalize_version (17.1), including later parameter and behavior changes
  • tags: the 20.0 API plus platform_tags (21.1), iOS (24.2), Android (25.0)
  • specifiers: 26.0 prerelease/unparsable-version changes on contains/filter
  • markers: EvaluateContext and evaluate(context=) (25.0), UndefinedEnvironmentNameKeyError (26.3)
  • version: major/minor/micro (20.0)
  • one each for requirements, pylock, errors, licenses

Also narrows the 26.3 Requirement equality note: name canonicalization dates to 23.2, so that directive now covers only extras and specifiers.

Versions were cross-checked against tagged file states (accounting for the src-layout move, which breaks naive git log on current paths).

https://claude.ai/code/session_01APjLVjop3cW91hskgMNZFN

henryiii added 3 commits July 20, 2026 20:46
Audit every public module against git history and the changelog, and add
the missing directives to docstrings and hand-written rst. Fix the 26.3
Requirement equality note to drop name normalization, which dates to 23.2.

Assisted-by: ClaudeCode:claude-fable-5
Claude-Session: https://claude.ai/code/session_01APjLVjop3cW91hskgMNZFN
…ions

Verified against packaging 25.0, which raised InvalidVersion where 26.0
returns False.

Assisted-by: ClaudeCode:claude-fable-5
Claude-Session: https://claude.ai/code/session_01APjLVjop3cW91hskgMNZFN
@henryiii
henryiii marked this pull request as ready for review July 21, 2026 03:28
Add versionadded directives for the direct_url (26.1), pylock (26.0),
dependency_groups (26.1), and ranges (26.3) modules.

Assisted-by: ClaudeCode:claude-opus-4.8
@henryiii
henryiii merged commit 45a8b34 into pypa:main Jul 28, 2026
69 checks passed
@henryiii
henryiii deleted the docs/versionadded-audit branch July 28, 2026 04:24
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.

Backfill .. versionadded and .. versionchanged in the API reference

2 participants