Skip to content

Commit

Permalink
pytest-beartype FAQ entry.
Browse files Browse the repository at this point in the history
This sterling commit by QA bodhisattva @tusharsadhwani (Tushar
Sadhwani) adds a new concise FAQ entry to our ReadTheDocs (RTD)-hosted
documentation advising everybody who wants to isolate @beartype to
test-time to now defer to the fearsome might of `pytest-beartype` (also
maintained by @tusharsadhwani, long may he live in splendor), resolving
long-standing documentation issue #200. (*Proud crows in a loud crowd!*)
  • Loading branch information
tusharsadhwani committed Feb 15, 2024
1 parent d0842a4 commit ae20e16
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/src/_links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@
https://ports.macports.org/port/py-beartype
.. _beartype PyPI:
https://pypi.org/project/beartype
.. _pytest-beartype PyPI:
https://pypi.org/project/pytest-beartype

.. # ------------------( LINKS ~ beartype : package : meta )------------------
.. _Libraries.io:
Expand Down
7 changes: 7 additions & 0 deletions doc/src/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1203,6 +1203,13 @@ your GigaChad IDE of choice.
.. #
.. # Beartype: *because you no longer care what static type-checkers think.*
*********************************************************
How do I \*ONLY\* type-check while running my test suite?
*********************************************************
If you use pytest_, you're in luck!
Check out the `aptly-named pytest-beartype<pytest-beartype PyPI_>`__ package.
**************************************
How do I \*NOT\* type-check something?
**************************************
Expand Down

0 comments on commit ae20e16

Please sign in to comment.