Fixed #26493 -- Documented how built-in signals are sent.

This commit is contained in:
Filipa Andrade 2016-04-13 10:04:24 +02:00 committed by Tim Graham
parent 1ee9c5b4a9
commit 47fbbc33de
2 changed files with 6 additions and 4 deletions

View File

@ -2,7 +2,8 @@
Signals
=======
A list of all the signals that Django sends.
A list of all the signals that Django sends. All built-in signals are sent
using the :meth:`~django.dispatch.Signal.send` method.
.. seealso::

View File

@ -235,9 +235,10 @@ There are two ways to send signals in Django.
.. method:: Signal.send(sender, **kwargs)
.. method:: Signal.send_robust(sender, **kwargs)
To send a signal, call either :meth:`Signal.send` or :meth:`Signal.send_robust`.
You must provide the ``sender`` argument (which is a class most of the time),
and may provide as many other keyword arguments as you like.
To send a signal, call either :meth:`Signal.send` (all built-in signals use
this) or :meth:`Signal.send_robust`. You must provide the ``sender`` argument
(which is a class most of the time) and may provide as many other keyword
arguments as you like.
For example, here's how sending our ``pizza_done`` signal might look::