summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorAdam Johnson <me@adamj.eu>2019-09-25 10:28:08 +0100
committerAdam Johnson <me@adamj.eu>2019-09-25 10:39:55 +0100
commitf4b7acedbf8dc0ed8fb14b00c9ba955e862512e8 (patch)
tree00397b0813135df895d5442f056e69f90644fc0c /docs/topics
parentfcaaff9862a93efe8ccd2a23b7e38d62dcf7a9d2 (diff)
[3.0.x] Documented admonition on when to use custom signals
Thanks Cesar Canassa for the suggestion and Aymeric Augustin for review. Backport of 566fca14b3e1406f918898de5bb2b2382a44edaf from master
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/signals.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt
index 817867a4ae..f61dee9f33 100644
--- a/docs/topics/signals.txt
+++ b/docs/topics/signals.txt
@@ -206,6 +206,12 @@ Defining and sending signals
Your applications can take advantage of the signal infrastructure and provide
its own signals.
+.. admonition:: When to use custom signals
+
+ Signals are implicit function calls which make debugging harder. If the
+ sender and receiver of your custom signal are both within your project,
+ you're better off using an explicit function call.
+
Defining signals
----------------