diff options
| author | Tim Graham <timograham@gmail.com> | 2016-01-12 12:28:55 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2016-01-12 12:28:55 -0500 |
| commit | 555f8e9d5c640373d2bd30ec1212b341c859f828 (patch) | |
| tree | f2bdf0255179b7672c09f8d646b627baf8d07cb6 /docs/howto | |
| parent | c68ce18712f5896fa9ab95afd69d590212f3c398 (diff) | |
Made CommandError use the exception directive in docs.
Diffstat (limited to 'docs/howto')
| -rw-r--r-- | docs/howto/custom-management-commands.txt | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt index 9956891fa6..0b71f1ef8b 100644 --- a/docs/howto/custom-management-commands.txt +++ b/docs/howto/custom-management-commands.txt @@ -87,9 +87,9 @@ The new custom command can be called using ``python manage.py closepoll The ``handle()`` method takes one or more ``poll_ids`` and sets ``poll.opened`` to ``False`` for each one. If the user referenced any nonexistent polls, a -:class:`CommandError` is raised. The ``poll.opened`` attribute does not exist -in the :doc:`tutorial</intro/tutorial01>` and was added to -``polls.models.Poll`` for this example. +:exc:`CommandError` is raised. The ``poll.opened`` attribute does not exist in +the :doc:`tutorial</intro/tutorial01>` and was added to ``polls.models.Poll`` +for this example. .. _custom-commands-options: @@ -254,7 +254,7 @@ All attributes can be set in your derived class and can be used in This option can't be ``False`` when the :data:`~BaseCommand.can_import_settings` option is set to ``False`` too because attempting to set the locale needs access to settings. This - condition will generate a :class:`CommandError`. + condition will generate a :exc:`CommandError`. .. attribute:: BaseCommand.style @@ -304,7 +304,7 @@ the :meth:`~BaseCommand.handle` method must be implemented. Tries to execute this command, performing system checks if needed (as controlled by the :attr:`requires_system_checks` attribute). If the command - raises a :class:`CommandError`, it's intercepted and printed to stderr. + raises a :exc:`CommandError`, it's intercepted and printed to stderr. .. admonition:: Calling a management command in your code @@ -321,7 +321,7 @@ the :meth:`~BaseCommand.handle` method must be implemented. .. method:: BaseCommand.check(app_configs=None, tags=None, display_num_errors=False) Uses the system check framework to inspect the entire Django project for - potential problems. Serious problems are raised as a :class:`CommandError`; + potential problems. Serious problems are raised as a :exc:`CommandError`; warnings are output to stderr; minor notifications are output to stdout. If ``app_configs`` and ``tags`` are both ``None``, all system checks are @@ -361,12 +361,10 @@ Rather than implementing :meth:`~BaseCommand.handle`, subclasses must implement Perform the command's actions for ``label``, which will be the string as given on the command line. -.. _ref-command-exceptions: - Command exceptions ------------------ -.. class:: CommandError +.. exception:: CommandError Exception class indicating a problem while executing a management command. |
