Skip to content

Commit

Permalink
mention inline stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
hauntsaninja committed Sep 26, 2023
1 parent 6ae2da9 commit 3175c28
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/typing_anti_pitch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,14 @@ You've made the decision that adding static types isn't the right choice for you
perhaps you'd still like to help your users who do use static type checking -- and maybe you have
some enthusiastic would-be contributors willing to help with this.

One option is encourage such contributors to publish a :pep:`561` stub-only package that is
One option is encourage such contributors to publish a :pep:`561` stub-only package that is
maintained separately from your main project. They could also contribute these stubs to the
`typeshed <https://github.com/python/typeshed>`_ project.

Note that if you're willing to maintain the stubs, but you don't wish to have them inline and don't
want to statically type check your code, you can accomplish this by distributing type stubs inside
your package. See :ref:`libraries` for more information.

If more users pester you about adding static types, feel free to link them to this document. And if
you ever change your mind, make sure to check out some of the other guides in this documentation,
and ask any questions you have over at `Python's typing discussions <https://github.com/python/typing/discussions>`_.

0 comments on commit 3175c28

Please sign in to comment.