Commit 8bf5cede authored by Filipa Andrade's avatar Filipa Andrade Committed by Tim Graham
Browse files

[1.9.x] Fixed #26493 -- Documented how built-in signals are sent.

Backport of 47fbbc33 from master
parent cc38262d
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -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::

+4 −3
Original line number Diff line number Diff line
@@ -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::