Browse Source

Fixed #25515 -- Documented the return value of BaseCommand.handle()

Tim Graham 9 years ago
parent
commit
3f766d44c5
1 changed files with 3 additions and 0 deletions
  1. 3 0
      docs/howto/custom-management-commands.txt

+ 3 - 0
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