Skip to content

Commit

Permalink
docs(changes): improve wording: "known typing limitations"
Browse files Browse the repository at this point in the history
  • Loading branch information
vytas7 committed Oct 15, 2024
1 parent da0c53a commit 4e8006b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/changes/4.0.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,14 @@ runtime behavior, but may surface new or different errors with type checkers.
Also, make sure to :ref:`let us know <chat>` which essential aliases are
missing from the public interface!

Known typing issues
^^^^^^^^^^^^^^^^^^^
Known typing limitations
^^^^^^^^^^^^^^^^^^^^^^^^

Falcon's emphasis on flexibility and performance has presented certain
challenges when it comes to adding type annotations to the existing code base.
One currently unresolved case involves using custom :class:`~falcon.Request`
and/or :class:`~falcon.Response` types in callbacks that are passed back to the
framework, such as when adding an
One notable limitation involves using custom :class:`~falcon.Request` and/or
:class:`~falcon.Response` types in callbacks that are passed back
to the framework, such as when adding an
:meth:`error handler <falcon.App.add_error_handler>`.

For instance, the following application might unexpectedly not pass type
Expand All @@ -112,7 +112,7 @@ checking:
app = App(request_type=MyRequest)
app.add_error_handler(OSError, handle_os_error)
(You can read more about this issue on GitHub:
(Please also see the following GitHub issue:
`#2372 <https://github.com/falconry/falcon/issues/2372>`__.)


Expand Down

0 comments on commit 4e8006b

Please sign in to comment.