Add note to docs about limitation of packages_distributions. Fixes #402.

python · Nov 24, 2022 · b74765d · b74765d
1 parent 18d5ea5
commit b74765d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/using.rst b/docs/using.rst
@@ -289,6 +289,10 @@ Python module or :term:`packaging:Import Package`::
     >>> packages_distributions()
     {'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...}
 
+Some editable installs, `do not supply top-level names
+<https://github.com/pypa/packaging-problems/issues/609>`_, and thus this
+function is not reliable with such installs.
+
 .. _distributions:
 
 Distributions