From 4e8006b45a0d6d7de1259a80e37028b6900a49db Mon Sep 17 00:00:00 2001 From: Vytautas Liuolia Date: Tue, 15 Oct 2024 21:47:02 +0200 Subject: [PATCH] docs(changes): improve wording: "known typing limitations" --- docs/changes/4.0.0.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/changes/4.0.0.rst b/docs/changes/4.0.0.rst index c5bf5764d..c7ac58268 100644 --- a/docs/changes/4.0.0.rst +++ b/docs/changes/4.0.0.rst @@ -80,14 +80,14 @@ runtime behavior, but may surface new or different errors with type checkers. Also, make sure to :ref:`let us know ` 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 `. For instance, the following application might unexpectedly not pass type @@ -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 `__.)