summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-10-06 15:08:15 -0400
committerTim Graham <timograham@gmail.com>2015-10-06 15:08:15 -0400
commit3f766d44c5ea000ecf47829ca565b1921dab2ac1 (patch)
tree3e3cb02e1524cd0c797f2eea1535fb4b045fb710
parentcb15ceb5555de0799210a0ce37e744fd4f284b36 (diff)
Fixed #25515 -- Documented the return value of BaseCommand.handle()
-rw-r--r--docs/howto/custom-management-commands.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt
index f42680b693..8986075c43 100644
--- a/docs/howto/custom-management-commands.txt
+++ b/docs/howto/custom-management-commands.txt
@@ -300,6 +300,9 @@ the :meth:`~BaseCommand.handle` method must be implemented.
The actual logic of the command. Subclasses must implement this method.
+ It may return a Unicode string which will be printed to ``stdout`` (wrapped
+ by ``BEGIN;`` and ``COMMIT;`` if :attr:`output_transaction` is ``True``).
+
.. method:: BaseCommand.check(app_configs=None, tags=None, display_num_errors=False)
Uses the system check framework to inspect the entire Django project for