Include documentation notes

This commit is contained in:
Aleksi Häkli 2019-05-19 16:55:53 +03:00 committed by Aleksi Häkli
parent f9e850fcbd
commit 465fe4529d
4 changed files with 15 additions and 15 deletions

View file

@ -84,9 +84,9 @@ Axes has the following warnings codes built in:
.. note:
Only disable the Axes system checks and warnings if you know what you are doing.
The default checks are implemented to verify and improve your project's security
and should only produce necessary warnings due to misconfigured settings.
Only disable the Axes system checks and warnings if you know what you are doing.
The default checks are implemented to verify and improve your project's security
and should only produce necessary warnings due to misconfigured settings.
Disabling Axes components in tests

View file

@ -62,9 +62,8 @@ configuration and customization documentation for further information.
.. note::
Please note that the functionality describe here concerns the default
database attempt tracker and handler. If you have customized or changed
the default handler to another class such as the cache handler,
you have to implement custom reset commands for it.
database handler. If you have changed the default handler to another
class such as the cache handler you have to implement custom reset commands.
Resetting attempts from the Django admin UI
@ -101,7 +100,7 @@ In your code, you can use the ``axes.utils.reset`` function.
- ``reset(ip=ip)`` will clear lockouts and records for the given IP address.
- ``reset(username=username)`` will clear lockouts and records for the given username.
Please note that if you give both ``username`` and ``ip`` arguments to ``reset``
that attempts that have both the set IP and username are reset.
The effective behaviour of ``reset`` is to ``and`` the terms instead of ``or`` ing them.
.. note:
Please note that if you give both ``username`` and ``ip`` arguments to ``reset``
that attempts that have both the set IP and username are reset.
The effective behaviour of ``reset`` is to ``and`` the terms instead of ``or`` ing them.

View file

@ -124,7 +124,7 @@ with the ``AXES_HANDLER`` setting in project configuration:
- ``axes.handlers.dummy.AxesDummyHandler``
does nothing with attempts and can be used to disable Axes handlers
if the user does not wish Axes to execute any logic on login signals.
Note that this effectively disables any Axes security features,
Please note that this effectively disables any Axes security features,
and is meant to be used on e.g. local development setups
and testing deployments where login monitoring is not wanted.

View file

@ -149,7 +149,8 @@ into ``my_namespace-username``:
AXES_USERNAME_CALLABLE = 'example.utils.get_username'
NOTE: You still have to make these modifications yourself before calling
authenticate. If you want to re-use the same function for consistency, that's
fine, but Axes does not inject these changes into the authentication flow
for you.
.. note:
You still have to make these modifications yourself before calling
authenticate. If you want to re-use the same function for consistency, that's
fine, but Axes does not inject these changes into the authentication flow
for you.