summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorevananyonga <evewish@gmail.com>2024-01-20 11:37:13 +0300
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2024-01-30 11:41:26 +0100
commit2822cafa3c38c8352eacb82aad27cc29338d8ad7 (patch)
treed1d029cc69b087f3075ce42a646939768b8fa0b4
parenta5440054d2285b2abf54251a33990fd9a6f94060 (diff)
[5.0.x] Corrected BaseCommand.check() signature in docs.
Backport of ae8baaee9d717cb48d59514b7130e35ae921d265 from main
-rw-r--r--docs/howto/custom-management-commands.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt
index b472f092e9..d3775905d3 100644
--- a/docs/howto/custom-management-commands.txt
+++ b/docs/howto/custom-management-commands.txt
@@ -304,7 +304,7 @@ the :meth:`~BaseCommand.handle` method must be implemented.
It may return a string which will be printed to ``stdout`` (wrapped
by ``BEGIN;`` and ``COMMIT;`` if :attr:`output_transaction` is ``True``).
-.. method:: BaseCommand.check(app_configs=None, tags=None, display_num_errors=False)
+.. method:: BaseCommand.check(app_configs=None, tags=None,display_num_errors=False, include_deployment_checks=False, fail_level=checks.ERROR, databases=None)
Uses the system check framework to inspect the entire Django project for
potential problems. Serious problems are raised as a :exc:`CommandError`;
@@ -312,8 +312,12 @@ the :meth:`~BaseCommand.handle` method must be implemented.
``stdout``.
If ``app_configs`` and ``tags`` are both ``None``, all system checks are
- performed. ``tags`` can be a list of check tags, like ``compatibility`` or
- ``models``.
+ performed except deployment and database related checks. ``tags`` can be a
+ list of check tags, like ``compatibility`` or ``models``.
+
+ You can pass ``include_deployment_checks=True`` to also perform deployment
+ checks, and list of database aliases in the ``databases`` to run database
+ related checks against them.
.. _ref-basecommand-subclasses: