Opened 3 years ago

Closed 3 years ago

#17625 closed Uncategorized (fixed)

Management command docs should mention underscore prefix

Reported by: murphyke Owned by: gnosek
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)

17625.diff (1.5 KB) - added by gnosek 3 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 Changed 3 years ago by chomik

  • Cc chomik added
  • Easy pickings set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Changed 3 years ago by gnosek

comment:2 Changed 3 years ago by gnosek

  • Has patch set
  • Owner changed from nobody to gnosek
  • Status changed from new to assigned

comment:3 Changed 3 years ago by oinopion

  • Triage Stage changed from Accepted to Ready for checkin

Describes stuff. Renders nicely. Good work.

comment:4 Changed 3 years ago by jezdez

  • Resolution set to fixed
  • Status changed from assigned to closed

In [17440]:

Fixed #17625 -- Mention in the management command docs that modules with an underscore prefix are ignored and not dissplayed in the list of commands.

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