Code

Opened 2 years ago

Closed 2 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: purple@… 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)

18187-1.diff (749 bytes) - added by claudep 2 years ago.
Added paragraph about command options

Download all attachments as: .zip

Change History (4)

Changed 2 years ago by claudep

Added paragraph about command options

comment:1 Changed 2 years ago by claudep

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Bug to Cleanup/optimization

See the attached patch. Is it what you were searching for?

comment:2 Changed 2 years ago by purple@…

Yes, thanks!

To be perfect you could add an example but this isn't mandatory.

comment:3 Changed 2 years ago by claudep

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

In [17930]:

Fixed #18187 -- Completed example and details about custom command options. Thanks purple for the report.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.