#32667: Clarify about tags on BaseCommand.require_system_checks
--------------------------------------+------------------------------------
Reporter: Abhyudai | Owner: nobody
Type: Cleanup/optimization | Status: assigned
Component: Core (System checks) | Version: 3.2
Severity: Normal | Resolution:
Keywords: documentation | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Mariusz Felisiak):
* keywords: => documentation
* component: Documentation => Core (System checks)
* stage: Unreviewed => Accepted
Comment:
IMO it should be enough to add a link to the
[https://docs.djangoproject.com/en/dev/topics/checks/#registering-and-
labeling-checks Registering and labeling checks], e.g.
{{{
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto
/custom-management-commands.txt
index 5d1a8ddd2d..e80540afaa 100644
--- a/docs/howto/custom-management-commands.txt
+++ b/docs/howto/custom-management-commands.txt
@@ -218,9 +218,10 @@ All attributes can be set in your derived class and
can be used in
.. attribute:: BaseCommand.requires_system_checks
A list or tuple of tags, e.g. ``[Tags.staticfiles, Tags.models]``.
System
- checks registered in the chosen tags will be checked for errors prior
to
- executing the command. The value ``'__all__'`` can be used to specify
- that all system checks should be performed. Default value is
``'__all__'``.
+ checks :ref:`registered in the chosen tags <registering-labeling-
checks>`
+ will be checked for errors prior to executing the command. The value
+ ``'__all__'`` can be used to specify that all system checks should be
+ performed. Default value is ``'__all__'``.
.. versionchanged:: 3.2
diff --git a/docs/topics/checks.txt b/docs/topics/checks.txt
index 438139ad31..1a5594fc27 100644
--- a/docs/topics/checks.txt
+++ b/docs/topics/checks.txt
@@ -77,6 +77,8 @@ implied by the class name.
* :class:`Error`
* :class:`Critical`
+.. _registering-labeling-checks:
+
Registering and labeling checks
-------------------------------
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32667#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/068.a403ccdb5bc035cd60ba326477b89ad8%40djangoproject.com.
