Skip to content

Commit

Permalink
[3.2.x] Refs #31055 -- Doc'd 'databases' argument of check functions.
Browse files Browse the repository at this point in the history
Backport of c8d3cbd from main
  • Loading branch information
adamchainz authored and felixxm committed Sep 10, 2021
1 parent 1f86ff3 commit 54684a3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/topics/checks.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down

0 comments on commit 54684a3

Please sign in to comment.