Skip to content

Commit

Permalink
Clarify DistributionFinder.Context.path type
Browse files Browse the repository at this point in the history
The DistributionFinder.Context.path property is a list of directory paths.

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
  • Loading branch information
pombredanne authored May 23, 2021
1 parent a956dc5 commit ab1c873
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions importlib_metadata/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -616,10 +616,11 @@ def __init__(self, **kwargs):
@property
def path(self):
"""
The path that a distribution finder should search.
The sequence of directory path that a distribution finder
should search.
Typically refers to Python package paths and defaults
to ``sys.path``.
Typically refers to Python installed package paths such as
"site-packages" directories and defaults to ``sys.path``.
"""
return vars(self).get('path', sys.path)

Expand Down

0 comments on commit ab1c873

Please sign in to comment.