Skip to content

Commit

Permalink
docs: note that type checking was introduced (#2287)
Browse files Browse the repository at this point in the history
indicate that some limitation apply
  • Loading branch information
CaselIT authored Aug 20, 2024
1 parent 6a9fc76 commit fbba897
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/changes/4.0.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@ Changes to Supported Platforms
later 4.x release, especially if we are faced with incompatible ecosystem
changes in typing, Cython, etc.

Typing support
--------------

Type checking support was introduced in version 4.0. While most of the library is
now typed, further type annotations may be added throughout the 4.x release cycle.
To improve them, we may introduce changes to the typing that do not affect
runtime behavior, but may surface new or different errors with type checkers.

.. note::

All type aliases in falcon are considered private, and if used should be
imported inside ``if TYPE_CHECKING:`` blocks to avoid possible import errors
after an update.

.. towncrier release notes start
Contributors to this Release
Expand Down

0 comments on commit fbba897

Please sign in to comment.