Browse Source

Documented admonition on when to use custom signals (#11814)

Thanks Cesar Canassa for the suggestion and Aymeric Augustin for review.
Adam Johnson 5 years ago
parent
commit
566fca14b3
1 changed files with 6 additions and 0 deletions
  1. 6 0
      docs/topics/signals.txt

+ 6 - 0
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
 ----------------