Skip to content

Commit b54050b

Browse files
committed
Add documentation to the Context attempting to clarify its purpose (and expectations regarding it).
1 parent 80b23ed commit b54050b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

importlib_metadata/__init__.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,16 @@ class DistributionFinder(MetaPathFinder):
359359
"""
360360

361361
class Context:
362+
"""
363+
Keyword arguments presented by the caller to
364+
``distributions()`` or ``Distribution.discover()``
365+
to narrow the scope of a search for distributions
366+
in all DistributionFinders.
367+
368+
Each DistributionFinder may expect any parameters
369+
and should attempt to honor the canonical
370+
parameters defined below when appropriate.
371+
"""
362372

363373
name = None
364374
"""

0 commit comments

Comments
 (0)