From d81b0812d43b8c068c8e65b19c1fa9dbdcb1da47 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 6 Oct 2015 15:08:15 -0400 Subject: [PATCH] [1.9.x] Fixed #25515 -- Documented the return value of BaseCommand.handle() Backport of 3f766d44c5ea000ecf47829ca565b1921dab2ac1 from master --- docs/howto/custom-management-commands.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt index d5dd800a94..833bc3840d 100644 --- a/docs/howto/custom-management-commands.txt +++ b/docs/howto/custom-management-commands.txt @@ -349,6 +349,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