summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdam Johnson <me@adamj.eu>2019-09-25 10:28:08 +0100
committerGitHub <noreply@github.com>2019-09-25 10:28:08 +0100
commit566fca14b3e1406f918898de5bb2b2382a44edaf (patch)
treeef050740d7db91a956abba0a2a718aeb0b4c6594 /docs
parentff5dfbc63a278219cd929449678b99ebec9a4b5f (diff)
Documented admonition on when to use custom signals (#11814)
Thanks Cesar Canassa for the suggestion and Aymeric Augustin for review.
Diffstat (limited to 'docs')
-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
----------------