gh-134740: Add missing documentation for importlib.metadata.distributions()#134749
Closed
ashm-dev wants to merge 3 commits intopython:mainfrom
Closed
gh-134740: Add missing documentation for importlib.metadata.distributions()#134749ashm-dev wants to merge 3 commits intopython:mainfrom
ashm-dev wants to merge 3 commits intopython:mainfrom
Conversation
ashm-dev
requested review from
brettcannon,
ericsnowcurrently,
ncoghlan and
warsaw
as code owners
|
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.metadata documentation despite being part of the public API.
ashm-dev
force-pushed
the
doc-importlib-metadata-distributions
branch
from
0112ab6 to
2e597d1
Compare
Member
Contributor
Author
Member
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
3 participants
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 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 in gh-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/