Skip to content

Commit

Permalink
docs: clean up xml_error_serialization docs & more
Browse files Browse the repository at this point in the history
  • Loading branch information
vytas7 committed Oct 6, 2024
1 parent 692de31 commit 9dda296
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
4 changes: 2 additions & 2 deletions falcon/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 9 additions & 6 deletions falcon/response.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <errors>` (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__ = (
Expand Down

0 comments on commit 9dda296

Please sign in to comment.