From ab1c87395260793c6002945d25a6931bf4f273de Mon Sep 17 00:00:00 2001 From: Philippe Ombredanne Date: Sun, 23 May 2021 16:49:45 +0200 Subject: [PATCH] Clarify DistributionFinder.Context.path type The DistributionFinder.Context.path property is a list of directory paths. Signed-off-by: Philippe Ombredanne --- importlib_metadata/__init__.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/importlib_metadata/__init__.py b/importlib_metadata/__init__.py index af4d48c5..4e1ea70b 100644 --- a/importlib_metadata/__init__.py +++ b/importlib_metadata/__init__.py @@ -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)