Skip to content

Commit

Permalink
docs: cleanups
Browse files Browse the repository at this point in the history
  • Loading branch information
CaselIT committed Aug 21, 2024
1 parent f09f633 commit c0d6a5c
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/api/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Options

.. _compiled_router_options:
.. autoclass:: falcon.routing.CompiledRouterOptions
:noindex:
:members:
12 changes: 4 additions & 8 deletions falcon/media/multipart.py
Original file line number Diff line number Diff line change
Expand Up @@ -552,32 +552,28 @@ class MultipartParseOptions:

default_charset: str
"""The default character encoding for
:meth:`text fields <BodyPart.get_text>` (default: ``utf-8``).
:meth:`text fields <BodyPart.get_text>` (default ``utf-8``).
"""

max_body_part_count: int
"""The maximum number of body parts in the form (default: 64).
"""The maximum number of body parts in the form (default ``64``).
If the form contains more parts than this number, an instance of
:class:`.MultipartParseError` will be raised. If this option is set to 0,
no limit will be imposed by the parser.
"""

max_body_part_buffer_size: int
"""The maximum number of bytes to buffer and return when the
:meth:`BodyPart.get_data` method is called (default: 1 MiB).
:meth:`BodyPart.get_data` method is called (default ``1 MiB``).
If the body part size exceeds this value, an instance of
:class:`.MultipartParseError` will be raised.
"""

max_body_part_headers_size: int
"""The maximum size (in bytes) of the body part headers structure (default: 8192).
"""The maximum size (in bytes) of the body part headers structure (default ``8192``).
If the body part headers size exceeds this value, an instance of
:class:`.MultipartParseError` will be raised.
"""

media_handlers: Handlers
"""A dict-like object for configuring the media-types to handle.
Expand Down
2 changes: 1 addition & 1 deletion falcon/response.py
Original file line number Diff line number Diff line change
Expand Up @@ -1230,7 +1230,7 @@ class ResponseOptions:

secure_cookies_by_default: bool
"""Set to ``False`` in development environments to make the ``secure`` attribute
for all cookies. (Default to ``False``).
for all cookies. (default ``False``).
This can make testing easier by not requiring HTTPS. Note, however, that this
setting can be overridden via :meth:`~.Response.set_cookie()`'s ``secure`` kwarg.
Expand Down
4 changes: 2 additions & 2 deletions falcon/routing/compiled.py
Original file line number Diff line number Diff line change
Expand Up @@ -921,8 +921,6 @@ class CompiledRouterOptions:
:py:class:`~.CompiledRouter` behaviors.
"""

__slots__ = ('converters',)

converters: ConverterDict
"""Represents the collection of named converters that may
be referenced in URI template field expressions.
Expand All @@ -948,6 +946,8 @@ class CompiledRouterOptions:
(See also: :ref:`Field Converters <routing_field_converters>`)
"""

__slots__ = ('converters',)

def __init__(self):
object.__setattr__(
self,
Expand Down

0 comments on commit c0d6a5c

Please sign in to comment.