Opened 8 years ago

Closed 7 years ago

Last modified 5 years ago

#9170 closed (fixed)

Write real documentation for custom management commands

Reported by: James Bennett Owned by: David Fischer
Component: Documentation Version: master
Severity: Keywords:
Cc: djfische@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The current documentation doesn't really provide any useful information.

A good starting point would be to give docstrings to the classes and functions in django/core/management/base.py.

Attachments (2)

9170_manage_command.diff (4.1 KB) - added by Eric Holscher 7 years ago.
Super basic example and simple reference
management-commands-9170.diff (9.7 KB) - added by David Fischer 7 years ago.
Added a complete tutorial of adding a management command

Download all attachments as: .zip

Change History (10)

comment:1 Changed 8 years ago by James Bennett

(In [9082]) Add some docstrings to the base classes for management commands. Refs #9170.

comment:2 Changed 8 years ago by anonymous

Might do a screencast on this as well. But real documentation is your friend as well.

comment:3 Changed 8 years ago by Eric Holscher

Triage Stage: UnreviewedAccepted

This is true. Two devs have blog posts on the topic, perhaps we should Sphinxify them and add them to the docs?

http://oebfare.com/blog/2008/nov/03/writing-custom-management-command/
http://www.b-list.org/weblog/2008/nov/14/management-commands/

Changed 7 years ago by Eric Holscher

Attachment: 9170_manage_command.diff added

Super basic example and simple reference

comment:4 Changed 7 years ago by Eric Holscher

Uploaded some basic docs that have a simple example and mention the different kinds of management commands. Not a lot, but this really needs some better docs!

Changed 7 years ago by David Fischer

Added a complete tutorial of adding a management command

comment:5 Changed 7 years ago by David Fischer

Cc: djfische@… added
Has patch: set
Owner: changed from nobody to David Fischer
Status: newassigned
Version: 1.0SVN

comment:6 Changed 7 years ago by Eric Holscher

milestone: 1.2

Applied this to trunk and it looks and works well. There is a mixing of reference material here with a turorial, so we might want to split that out into a seperate page, but it seems small enough that keeping it together also makes sense.

I think this should go into 1.2 though, because this has been an oddly undocumented part of Django for a while.

comment:7 Changed 7 years ago by Brian Rosner

Resolution: fixed
Status: assignedclosed

(In [13138]) Fixed #9170 -- added improved custom management command documentation.

Thanks to David Fischer and Eric Holscher for their work on initial patches.

comment:8 Changed 5 years ago by Jacob

milestone: 1.2

Milestone 1.2 deleted

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