#32667: Clarify about tags on BaseCommand.require_system_checks
------------------------------------------------+--------------------------
Reporter: abhiabhi94 | Owner: nobody
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+--------------------------
The current documentation regarding
[https://docs.djangoproject.com/en/3.2/howto/custom-management-
commands/#django.core.management.BaseCommand.requires_system_checks/
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/32667>
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/053.5bc9a938697e5967f5f3a9f5a2a3edd2%40djangoproject.com.
