From 9dda29678ac78f4291622e97f24b636da292a91f Mon Sep 17 00:00:00 2001 From: Vytautas Liuolia Date: Sun, 6 Oct 2024 15:07:25 +0200 Subject: [PATCH] docs: clean up xml_error_serialization docs & more --- falcon/request.py | 4 ++-- falcon/response.py | 15 +++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/falcon/request.py b/falcon/request.py index 64f9312e1..d23fd388e 100644 --- a/falcon/request.py +++ b/falcon/request.py @@ -2426,11 +2426,11 @@ def auto_parse_form_urlencoded(self) -> bool: via :attr:`~falcon.Request.params`, :meth:`~falcon.Request.get_param`, etc. - Warning: + .. deprecated:: 3.0 The `auto_parse_form_urlencoded` option is not supported for ASGI apps, and is considered deprecated for WSGI apps as of Falcon 3.0, in favor of accessing URL-encoded forms - through :attr:`~Request.media`. + through :meth:`~falcon.Request.get_media`. The attribute and the auto-parsing functionality will be removed entirely in Falcon 5.0. diff --git a/falcon/response.py b/falcon/response.py index 2a556c3f0..6bb6f7ee2 100644 --- a/falcon/response.py +++ b/falcon/response.py @@ -1397,19 +1397,22 @@ class ResponseOptions: """ xml_error_serialization: bool """Set to ``False`` to disable automatic inclusion of the XML handler - in the default error serializer (:ref:`errors`) (default ``True``). + in the :ref:`default error serializer ` (default ``True``). - Enabling this option does not automatically render all error response in XML, - but only if the client prefers (via the ``Accept`` request header) XML to JSON - and other configured media handlers. + Enabling this option does not make Falcon automatically render all error + responses in XML, but it is used only in the case the client prefers + (via the ``Accept`` request header) XML to JSON and other configured media + handlers. Note: - This option will default to ``False`` in Falcon 5.0 disabling XML error - serialization by default). + Falcon 5.0 will either change the default to ``False``, or remove the + automatic XML error serialization altogether. Note: This option has no effect when a custom error serializer, set using :meth:`~falcon.App.set_error_serializer`, is in use. + + .. versionadded:: 4.0 """ __slots__ = (