Browse files

Fixed #17799 - Documented that the execute() method of a management c…

…ommand is not suitable for calling the command from code; call_command should be used instead. Thanks kacah222 for the report and claudep for the patch.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent fcaf8ea commit 3ed0b6ed64ff7a69644d1c1eacfb62b0aedadf71 @carljm carljm committed Mar 2, 2012
Showing with 7 additions and 0 deletions.
  1. +5 −0 docs/howto/custom-management-commands.txt
  2. +2 −0 docs/ref/django-admin.txt
@@ -243,6 +243,11 @@ the :meth:`~BaseCommand.handle` method must be implemented.
:class:`CommandError`, intercept it and print it sensibly to
+.. admonition:: Calling a management command in your code
+ ``execute()`` should not be called directly from your code to execute a
+ command. Use :ref:`call_command <call-command>` instead.
.. method:: BaseCommand.handle(*args, **options)
The actual logic of the command. Subclasses must implement this method.
@@ -1490,6 +1490,8 @@ See :doc:`/howto/custom-management-commands` for how to add customized actions.
Running management commands from your code
+.. _call-command:
.. function::, *args, **options)
To call a management command from code use ``call_command``.

0 comments on commit 3ed0b6e

Please sign in to comment.