Skip to content

Commit 4212eed

Browse files
committed
Update documentation to capture existing behavior. Closes #372.
1 parent a6b4e2e commit 4212eed

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/using.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,15 @@ The full set of available metadata is not described here. See :pep:`566`
274274
for additional details.
275275

276276

277+
Distribution Discovery
278+
======================
279+
280+
By default, this package provides built-in support for discovery of metadata for file system and zip file packages. This metadata finder search defaults to ``sys.path``, but varies slightly in how it interprets those values from how other import machinery does. In particular:
281+
282+
- ``importlib_metadata`` does not honor :type:`bytes` objects on ``sys.path``.
283+
- ``importlib_metadata`` will incidentally honor :py:class:`pathlib.Path` objects on ``sys.path`` even though such values will be ignored for imports.
284+
285+
277286
Extending the search algorithm
278287
==============================
279288

0 commit comments

Comments
 (0)