Skip to content

Commit

Permalink
Mention that type-stubs need to be contained in a package directory.
Browse files Browse the repository at this point in the history
Closes #4713.
  • Loading branch information
abravalheri committed Oct 30, 2024
1 parent 3e3d16d commit 8116f8e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/userguide/miscellaneous.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down

0 comments on commit 8116f8e

Please sign in to comment.