Django

Code

Ticket #9170 (assigned)

Opened 1 year ago

Last modified 2 weeks ago

Write real documentation for custom management commands

Reported by: ubernostrum Assigned to: davidfischer (accepted)
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: djfische@gmail.com Triage Stage: Accepted
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

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

9170_manage_command.diff (4.1 kB) - added by ericholscher on 10/15/09 23:41:04.
Super basic example and simple reference
management-commands-9170.diff (9.7 kB) - added by davidfischer on 03/04/10 01:35:19.
Added a complete tutorial of adding a management command

Change History

09/22/08 01:03:26 changed by ubernostrum

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

09/22/08 01:05:17 changed by anonymous

  • needs_better_patch changed.
  • needs_tests changed.
  • needs_docs changed.

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

02/25/09 21:47:02 changed by ericholscher

  • stage changed from Unreviewed to Accepted.

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/

10/15/09 23:41:04 changed by ericholscher

  • attachment 9170_manage_command.diff added.

Super basic example and simple reference

10/15/09 23:42:36 changed by ericholscher

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!

03/04/10 01:35:19 changed by davidfischer

  • attachment management-commands-9170.diff added.

Added a complete tutorial of adding a management command

03/04/10 01:41:33 changed by davidfischer

  • cc set to djfische@gmail.com.
  • owner changed from nobody to davidfischer.
  • has_patch set to 1.
  • version changed from 1.0 to SVN.
  • status changed from new to assigned.

Add/Change #9170 (Write real documentation for custom management commands)




Change Properties
Action