Improve documentation

Improve language for easier readability
Add missing Axes.W004 check code to docs
Update flow image with better diagram language
This commit is contained in:
Aleksi Häkli 2019-06-02 13:23:48 +03:00
parent e93e0d3f89
commit dfcc63b2cd
No known key found for this signature in database
GPG key ID: 3E7146964D726BBE
3 changed files with 6 additions and 5 deletions

View file

@ -85,6 +85,7 @@ Axes has the following warnings codes built in:
- ``axes.W001`` for invalid ``CACHES`` configuration.
- ``axes.W002`` for invalid ``MIDDLEWARE`` configuration.
- ``axes.W003`` for invalid ``AUTHENTICATION_BACKENDS`` configuration.
- ``axes.W004`` for deprecated use of ``AXES_*`` setting flags.
.. note::
@ -96,10 +97,10 @@ Axes has the following warnings codes built in:
Disabling Axes components in tests
----------------------------------
If you get errors when running tests or other configurations, try setting the ``AXES_ENABLED``
flag to ``False`` in your project or test settings configuration file::
If you get errors when running tests, try setting the
``AXES_ENABLED`` flag to ``False`` in your test settings::
AXES_ENABLED = False
This disables the Axes middleware, authentication backend and signal handlers
which might produce errors with exotic test configurations.
This disables the Axes middleware, authentication backend and signal receivers,
which might fix errors with incompatible test configurations.

View file

@ -73,5 +73,5 @@ to log in users or otherwise take care of notifying Axes of authentication
attempts and failures the same way Django does via authentication signals.
The login flows can be customized and the Axes
authentication backend, middleware, and handlers
authentication backend, middleware, and signal receivers
can easily be swapped to alternative implementations.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

After

Width:  |  Height:  |  Size: 130 KiB