Skip to content

Commit 9436e24

Browse files
committed
Add note to usage docs referring to PEP 427 directive discouraging use of wheels on sys.path. Fixes #52.
1 parent d1e9ba6 commit 9436e24

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

importlib_metadata/docs/using.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ By default, package metadata can live on the file system or in wheels on
2222
``sys.path``. Through an extension mechanism, the metadata can live almost
2323
anywhere.
2424

25+
.. note:: Although this package supports loading metadata from wheels
26+
on ``sys.path``, that support is provisional and does not serve to
27+
contravene the `PEP 427 directive
28+
<https://www.python.org/dev/peps/pep-0427/#is-it-possible-to-import-python-code-directly-from-a-wheel-file>`_,
29+
which states that relying on this format is discouraged, and use is
30+
at your own risk.
31+
2532

2633
Overview
2734
========

0 commit comments

Comments
 (0)