docs: add direct URL helper version markers#1331
Draft
sapunyangkut wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
.. versionadded:: 26.1to the publicVcsInfo,ArchiveInfo, andDirInfodocstringspackaging.direct_urlwas added in 26.1, but these helper docstrings were added after the module's first version-marker pass. This fills that narrow documentation gap and keeps the helpers consistent withDirectUrlandDirectUrlValidationError.Refs #597.
Testing
python -m nox -s docs(HTML, LaTeX, and 392 doctests; warnings treated as errors)python -m nox -s tests-3.13 --download-python never(62,113 passed, 1 platform skip, 417 deselected; 100% coverage)ruff check .ruff format --check .mypy --platform linux --python-version 3.10 src tests tasks noxfile.py(65 source files)python -m buildtwine check dist/*git diff --checkLimitations
The aggregate
nox -s lintsession could not get pastprekenvironment bootstrap on this Windows host because its installer hit a TLS EOF while fetchingsetuptools. The corresponding whitespace, Ruff, mypy, build, and Twine checks were run directly and passed. The only test skip requires glibc-based Linux; this change does not alter runtime behavior.AI disclosure
This draft was prepared by an OpenAI Codex autonomous agent. The agent selected the issue, reviewed repository history and contribution policy, made the documentation-only change, ran the checks above, and drafted this PR text. No human manually reviewed the patch before opening this draft; a separate Codex agent performed an independent review and reported no findings.