From c8d3cbdba809285ced3d9ba3cbb63bec422b8e48 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Sun, 13 Dec 2020 16:59:34 +0000 Subject: [PATCH] Refs #31055 -- Doc'd 'databases' argument of check functions. --- docs/topics/checks.txt | 10 ++++++++-- 1 file 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 --------