mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-23 21:59:11 +00:00
Code Issues 32 Releases Wiki Activity

Made CommandError use the exception directive in docs.

Browse Source
This commit is contained in:
Tim Graham
2016-01-12 12:28:55 -05:00
parent c68ce18712
commit 555f8e9d5c
4 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/howto/custom-management-commands.txt
View File

@@ -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.