Skip to content

Commit

Permalink
Add clarification to default limits documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alisaifee committed Feb 27, 2023
1 parent 5d4174a commit ffae492
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doc/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ take priority.
Constructor argument: :paramref:`~flask_limiter.Limiter.default_limits`

- A comma (or some other delimiter) separated string that will be used to
apply a default limit on all routes. If not provided, the default limits can be
apply a default limit on all routes that are otherwise not decorated with
an explicit rate limit. If not provided, the default limits can be
passed to the :class:`~flask_limiter.Limiter` constructor as well (the values passed to the
constructor take precedence over those in the config).
:ref:`ratelimit-string` for details.
Expand Down
4 changes: 2 additions & 2 deletions flask_limiter/extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ class Limiter:
by.
:param app: :class:`flask.Flask` instance to initialize the extension with.
:param default_limits: a variable list of strings or callables
returning strings denoting default limits to apply to all routes.
:ref:`ratelimit-string` for more details.
returning strings denoting default limits to apply to all routes that are
not explicitely decorated with a limit. :ref:`ratelimit-string` for more details.
:param default_limits_per_method: whether default limits are applied
per method, per route or as a combination of all method per route.
:param default_limits_exempt_when: a function that should return
Expand Down

0 comments on commit ffae492

Please sign in to comment.