Added `muted` context manager for temproary switching signal off (#84)

This is useful whilst testing to remove a signal's affects.

Co-authored-by: Michael Elovskikh <wronglink@yandex-team.ru>

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