[3.2.x] Refs #31055 -- Doc'd 'databases' argument of check functions.

Backport of c8d3cbdba8 from main
This commit is contained in:
Adam Johnson 2020-12-13 16:59:34 +00:00 committed by Mariusz Felisiak
parent 1f86ff31b1
commit 54684a3ec0
1 changed files with 8 additions and 2 deletions

View File

@ -48,8 +48,14 @@ check function::
The check function *must* accept an ``app_configs`` argument; this argument is
the list of applications that should be inspected. If ``None``, the check must
be run on *all* installed apps in the project. The ``**kwargs`` argument is
required for future expansion.
be run on *all* installed apps in the project.
The check will receive a ``databases`` keyword argument. This is a list of
database aliases whose connections may be used to inspect database level
configuration. If ``databases`` is ``None``, the check must not use any
database connections.
The ``**kwargs`` argument is required for future expansion.
Messages
--------