diff options
author | Filipa Andrade <filipa.andrade@gmail.com> | 2016-04-13 10:04:24 +0200 |
---|---|---|
committer | Tim Graham <timograham@gmail.com> | 2016-04-13 07:52:32 -0400 |
commit | 8bf5cede3785a49b90737440eb9cc082ff29c054 (patch) | |
tree | 422661802a902906f775e8578cacd56732eea604 | |
parent | cc38262d40b51198fa3e15074e2b8daa37646e8f (diff) | |
download | django-8bf5cede3785a49b90737440eb9cc082ff29c054.tar.gz |
[1.9.x] Fixed #26493 -- Documented how built-in signals are sent.
Backport of 47fbbc33de805c803c39483344854caa2890c32c from master
-rw-r--r-- | docs/ref/signals.txt | 3 | ||||
-rw-r--r-- | docs/topics/signals.txt | 7 |
2 files changed, 6 insertions, 4 deletions
diff --git a/docs/ref/signals.txt b/docs/ref/signals.txt index 77378b0a48..e28bab2c12 100644 --- a/docs/ref/signals.txt +++ b/docs/ref/signals.txt @@ -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:: diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt index fbc2409570..a92f34d8f3 100644 --- a/docs/topics/signals.txt +++ b/docs/topics/signals.txt @@ -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:: |