Opened 13 years ago
Closed 13 years ago
#17625 closed Uncategorized (fixed)
Management command docs should mention underscore prefix
Reported by: | murphyke | Owned by: | Grzegorz Nosek |
---|---|---|---|
Component: | Documentation | Version: | 1.4-alpha-1 |
Severity: | Normal | Keywords: | |
Cc: | chomik | Triage Stage: | Ready for checkin |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
The documentation for custom management commands should mention how to exclude source files from being listed or used as management commands. I've confirmed that the dev docs do not mention this.
Looking at the (1.3) source code for django.core.management, I see that files prefixed with underscores ("_") are ignored or prevented from being considered as management commands.
Being able to do so is occasionally important, as when several commands depend on a helper class.
Reference: https://docs.djangoproject.com/en/dev/howto/custom-management-commands/
Attachments (1)
Change History (5)
comment:1 by , 13 years ago
Cc: | added |
---|---|
Easy pickings: | set |
Triage Stage: | Unreviewed → Accepted |
by , 13 years ago
Attachment: | 17625.diff added |
---|
comment:2 by , 13 years ago
Has patch: | set |
---|---|
Owner: | changed from | to
Status: | new → assigned |
comment:3 by , 13 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
Describes stuff. Renders nicely. Good work.