summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2014-04-25 23:13:58 +0200
committerClaude Paroz <claude@2xlibre.net>2014-04-25 23:16:24 +0200
commitabd68b5affaec35e941b49f1b0a4cb8d70c22d7b (patch)
tree6dab320b3153260ad17bdb0d20c563aacd0ec9d4 /docs
parent6b38e48ba11ec3d5aa433948d1354a8627c1edba (diff)
[1.7.x] Fixed #22507 -- Clarified nature of the sender argument of signals
Backport of d1f93e9c1e from master.
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/signals.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt
index ee6fb847a2..346d47d179 100644
--- a/docs/topics/signals.txt
+++ b/docs/topics/signals.txt
@@ -235,7 +235,8 @@ For example:
This declares a ``pizza_done`` signal that will provide receivers with
``toppings`` and ``size`` arguments.
-Remember that you're allowed to change this list of arguments at any time, so getting the API right on the first try isn't necessary.
+Remember that you're allowed to change this list of arguments at any time, so
+getting the API right on the first try isn't necessary.
Sending signals
---------------
@@ -246,8 +247,8 @@ There are two ways to send signals in Django.
.. 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, and may provide as many other keyword
-arguments as you like.
+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:
@@ -257,7 +258,7 @@ For example, here's how sending our ``pizza_done`` signal might look:
...
def send_pizza(self, toppings, size):
- pizza_done.send(sender=self, toppings=toppings, size=size)
+ pizza_done.send(sender=self.__class__, toppings=toppings, size=size)
...
Both ``send()`` and ``send_robust()`` return a list of tuple pairs