mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity

Corrected BaseCommand.check() signature in docs.

Browse Source
This commit is contained in:
evananyonga 2024-01-20 11:37:13 +03:00 committed by Mariusz Felisiak
parent 820c5f1bac
commit ae8baaee9d
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/howto/custom-management-commands.txt
View File

@ -304,7 +304,7 @@ the :meth:`~BaseCommand.handle` method must be implemented.
It may return a string which will be printed to ``stdout`` (wrapped It may return a string which will be printed to ``stdout`` (wrapped
by ``BEGIN;`` and ``COMMIT;`` if :attr:`output_transaction` is ``True``). 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 Uses the system check framework to inspect the entire Django project for
potential problems. Serious problems are raised as a :exc:`CommandError`; potential problems. Serious problems are raised as a :exc:`CommandError`;
@ -312,8 +312,12 @@ the :meth:`~BaseCommand.handle` method must be implemented.
``stdout``. ``stdout``.
If ``app_configs`` and ``tags`` are both ``None``, all system checks are If ``app_configs`` and ``tags`` are both ``None``, all system checks are
performed. ``tags`` can be a list of check tags, like ``compatibility`` or performed except deployment and database related checks. ``tags`` can be a
``models``. 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: .. _ref-basecommand-subclasses: