Mention that type stubs need to be contained in a package directory (#…

…4715)
pypa · Oct 30, 2024 · fcdaf02 · fcdaf02
2 parents 3e3d16d + 8116f8e
commit fcdaf02
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/userguide/miscellaneous.rst b/docs/userguide/miscellaneous.rst
@@ -38,7 +38,9 @@ of ``setuptools``. The behavior of older versions might differ.
    .. versionadded:: v69.0.0
       ``setuptools`` will attempt to include type information files
       by default in the distribution
-      (``.pyi`` and ``py.typed``, as specified in :pep:`561`).
+      (``.pyi`` and ``py.typed``, as specified in :pep:`561`),
+      as long as they are contained inside of a package directory
+      (for the time being there is no automatic support for top-level ``.pyi`` files).
 
     *Please note however that this feature is* **EXPERIMENTAL** *and may change in
     the future.*