Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#32667 closed Cleanup/optimization (fixed)

Clarify about tags on BaseCommand.require_system_checks

Reported by: Abhyudai Owned by: Abhyudai
Component: Core (System checks) Version: 3.2
Severity: Normal Keywords: documentation
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

The current documentation regarding requires_system_checks mention Tags but it isn't very clear where Tags come from. I'm just quoting the documentation here for easy of conversation.

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'.

I didn't exactly find a definition on that page.

Digging into the source, I found that Tags actually come from django.core.registry.check. I think it would be worthwhile mentioning the actual reference here. I could potentially make the documentation more clear.

If acceptable, I would be willing to make the patch for it.

Change History (5)

comment:1 by Mariusz Felisiak, 3 years ago

Component: DocumentationCore (System checks)
Keywords: documentation added
Triage Stage: UnreviewedAccepted

IMO it should be enough to add a link to the 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
 -------------------------------
 

comment:2 by Abhyudai, 3 years ago

Owner: changed from nobody to Abhyudai

comment:3 by Mariusz Felisiak, 3 years ago

Has patch: set

comment:4 by GitHub <noreply@…>, 3 years ago

Resolution: fixed
Status: assignedclosed

In 4a77aeb1:

Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs.

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@…>

comment:5 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

In 7d7c6d9:

[3.2.x] Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs.

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@…>
Backport of 4a77aeb1f86bc06e18023cac10109e067ed20800 from main

Note: See TracTickets for help on using tickets.
Back to Top