#9170 closed (fixed)
Write real documentation for custom management commands
Reported by: | James Bennett | Owned by: | David Fischer |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | djfische@… | Triage Stage: | Accepted |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
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)
Change History (10)
comment:1 by , 16 years ago
comment:2 by , 16 years ago
Might do a screencast on this as well. But real documentation is your friend as well.
comment:3 by , 16 years ago
Triage Stage: | Unreviewed → 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/
by , 15 years ago
Attachment: | 9170_manage_command.diff added |
---|
Super basic example and simple reference
comment:4 by , 15 years ago
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!
by , 15 years ago
Attachment: | management-commands-9170.diff added |
---|
Added a complete tutorial of adding a management command
comment:5 by , 15 years ago
Cc: | added |
---|---|
Has patch: | set |
Owner: | changed from | to
Status: | new → assigned |
Version: | 1.0 → SVN |
comment:6 by , 15 years ago
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 by , 15 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
(In [9082]) Add some docstrings to the base classes for management commands. Refs #9170.