📝 docs(api): add :param: descriptions to all public APIs#32
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Feb 26, 2026
Merged
📝 docs(api): add :param: descriptions to all public APIs#32gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
Hatch monkeypatches `propose_interpreters` to filter out incompatible interpreters, which broke when virtualenv moved discovery to this package. Adding a `predicate` callback gives downstream tools a public API to filter interpreters without monkeypatching internals. Named `predicate` instead of `filter` to avoid shadowing the Python builtin (ruff A002). Closes tox-dev#30
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
1 participant
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.
The Sphinx API reference was rendering parameter signatures without descriptions for most public methods and constructors. While
sphinx-autodoc-typehintspicks up types from annotations, parameter purpose still needs explicit:param:docstrings to appear in the rendered docs.This adds
:param:descriptions to every public method, constructor, and dataclass acrossPythonInfo,PythonSpec,DiskCache,SimpleVersion,SimpleSpecifier, andSimpleSpecifierSet. Parameters that were already referenced inline with*param*emphasis were expanded to proper Sphinx:param:directives so they render consistently in the API reference.