Opened 13 years ago
Closed 13 years ago
#18187 closed Cleanup/optimization (fixed)
In adding options to custom commands the doc stop too early and therefor miss an important information
| Reported by: | Owned by: | nobody | |
|---|---|---|---|
| Component: | Documentation | Version: | 1.4 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
Here: https://docs.djangoproject.com/en/1.4/howto/custom-management-commands/ starting here:
"The same closepoll could be easily modified to delete a given poll instead of closing it by accepting additional command line options. These custom options ..."
The documentation doesn't say anywhere that the option will be stored in the dict "options" pass as argument of the method. As obvious as it sounds I've add to google it to find this information and apparently I'm far from being the only one: http://stackoverflow.com/questions/4208006/how-does-one-use-django-custom-management-command-option (it's sad that no one since 2010 has repported this bug :/).
Documentation should always state the obvious.
Kind regards,
Attachments (1)
Change History (4)
by , 13 years ago
| Attachment: | 18187-1.diff added |
|---|
comment:1 by , 13 years ago
| Has patch: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
| Type: | Bug → Cleanup/optimization |
See the attached patch. Is it what you were searching for?
comment:2 by , 13 years ago
Yes, thanks!
To be perfect you could add an example but this isn't mandatory.
Added paragraph about command options