summaryrefslogtreecommitdiff
path: root/docs
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:09:58 -0400
commit9be9c511cc9f552a34367427aaac3bdc0fdb88fc (patch)
tree775297ce422d0d2cef07996ce518d26283a69f65 /docs
parente2db171e15b8d7d924cc4b1e0c67c96478c2644b (diff)
[1.8.x] Fixed #25515 -- Documented the return value of BaseCommand.handle()
Backport of 3f766d44c5ea000ecf47829ca565b1921dab2ac1 from master
Diffstat (limited to 'docs')
-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 6547bf5182..4e55111b81 100644
--- a/docs/howto/custom-management-commands.txt
+++ b/docs/howto/custom-management-commands.txt
@@ -366,6 +366,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)
.. versionadded:: 1.7