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:02:28 +0200 |
| commit | c8d3cbdba809285ced3d9ba3cbb63bec422b8e48 (patch) | |
| tree | e2dc0d5a8cb6da7bb7cc63c119652d1ae384708f | |
| parent | de95c826673be9ea519acc86fd898631d1a11356 (diff) | |
| download | django-c8d3cbdba809285ced3d9ba3cbb63bec422b8e48.tar.gz | |
Refs #31055 -- Doc'd 'databases' argument of check functions.
| -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 -------- |