diff options
| author | Adam Johnson <me@adamj.eu> | 2020-12-13 16:59:34 +0000 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2021-09-10 11:48:20 +0200 |
| commit | 54684a3ec03725f605461f4460da550550e34a00 (patch) | |
| tree | eacdb6170ea284d0b3dcfd2a77e84bf894dac11a /docs | |
| parent | 1f86ff31b12c6bc30fbc0e1592b6d186e928fb07 (diff) | |
[3.2.x] Refs #31055 -- Doc'd 'databases' argument of check functions.
Backport of c8d3cbdba809285ced3d9ba3cbb63bec422b8e48 from main
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/topics/checks.txt | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/topics/checks.txt b/docs/topics/checks.txt index 1a5594fc27..9586466285 100644 --- a/docs/topics/checks.txt +++ b/docs/topics/checks.txt @@ -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 -------- |
