mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 01:55:49 +00:00
Code Issues 25 Releases Wiki Activity

Fixed #22507 -- Clarified nature of the sender argument of signals

Browse Source
This commit is contained in:
Claude Paroz 2014-04-25 23:13:58 +02:00
parent 3033a7193a
commit d1f93e9c1e
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/topics/signals.txt
View File

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