summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEd Morley <emorley@mozilla.com>2017-01-17 14:57:26 +0000
committerTim Graham <timograham@gmail.com>2017-01-17 13:21:01 -0500
commit0ecc3fc498ba3c15380acfd2742b41e7121d8d6c (patch)
treea27cf13e4b26faa5be322870945b97d75c70bc9e /docs
parent04446b60f29dcbadc1a73bd3a916dcf9a4b0f445 (diff)
[1.10.x] Fixed #27739 -- Documented LabelCommand.label.
Backport of 44cce3ed00afe7a404e9f6cba0f6292223c7fe0a from master
Diffstat (limited to 'docs')
-rw-r--r--docs/howto/custom-management-commands.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt
index 0d12246c0f..c209d16271 100644
--- a/docs/howto/custom-management-commands.txt
+++ b/docs/howto/custom-management-commands.txt
@@ -365,6 +365,12 @@ the command line, and does something with each of them.
Rather than implementing :meth:`~BaseCommand.handle`, subclasses must implement
:meth:`~LabelCommand.handle_label`, which will be called once for each label.
+.. attribute:: LabelCommand.label
+
+ A string describing the arbitrary arguments passed to the command. The
+ string is used in the usage text and error messages of the command.
+ Defaults to ``'label'``.
+
.. method:: LabelCommand.handle_label(label, **options)
Perform the command's actions for ``label``, which will be the string as