Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-134740: Add missing documentation for importlib.metadata.distributions()#134749
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
ashm-dev wants to merge3 commits intopython:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+57 −0
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
python-cla-botbot commentedMay 26, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
All commit authors signed the Contributor License Agreement. |
…tions()Add documentation for the distributions() function, Distribution.discover() method,and DistributionFinder classes that were missing from the importlib.metadatadocumentation despite being part of the public API.
0112ab6 to2e597d1CompareSign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
Summary of Changes
Add documentation for:
These items were part of the public API (included in
__all__) but were missing from the documentation. The PR adds proper documentation for these items in the same style as the existing documentation, including descriptions of parameters and return values.Issue Details
The issue was reported ingh-134740 where it was noted that importlib.metadata.distributions() is not listed in the documentation despite being in
__all__and referred to in the docstrings for several other module items. The DistributionFinder and DistributionFinder.Context classes were also missing from the documentation.Changes Made
Related Issues
Closes#134740
Related to#134740
importlib.metadata.distributions()#134740📚 Documentation preview 📚:https://cpython-previews--134749.org.readthedocs.build/