summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 92b89ba..9c733bb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -157,6 +157,19 @@ value``) pairs:
[(<function receive_data at 0x...>, 'received!')]
+Muting signals
+--------------
+
+To mute a signal, as may be required when testing, the
+:meth:`~Signal.muted` can be used as a context decorator:
+
+.. code-block:: python
+
+ sig = signal('send-data')
+ with sig.muted():
+ ...
+
+
Anonymous Signals
-----------------