Skip to content

Commit

Permalink
Update documentation to capture existing behavior. Closes #372.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Mar 19, 2022
1 parent a6b4e2e commit 4212eed
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/using.rst
Expand Up @@ -274,6 +274,15 @@ The full set of available metadata is not described here. See :pep:`566`
for additional details.


Distribution Discovery
======================

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:

- ``importlib_metadata`` does not honor :type:`bytes` objects on ``sys.path``.
- ``importlib_metadata`` will incidentally honor :py:class:`pathlib.Path` objects on ``sys.path`` even though such values will be ignored for imports.


Extending the search algorithm
==============================

Expand Down

0 comments on commit 4212eed

Please sign in to comment.