summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAndriy Sokolovskiy <sokandpal@yandex.ru>2015-01-02 16:25:33 +0200
committerTim Graham <timograham@gmail.com>2015-01-02 12:00:41 -0500
commit23f1a8dad223ee79cd206c9032c871c874f7e7af (patch)
treec1ca30cf38e2d880e5c808a425fa0673dbf5192b /docs
parent937fab030d48021ccd266c67016aeaef91362e2c (diff)
Added return value to Signal.disconnect().
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/signals.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt
index dab29ba4ec..7722379769 100644
--- a/docs/topics/signals.txt
+++ b/docs/topics/signals.txt
@@ -278,7 +278,12 @@ Disconnecting signals
.. method:: Signal.disconnect([receiver=None, sender=None, weak=True, dispatch_uid=None])
To disconnect a receiver from a signal, call :meth:`Signal.disconnect`. The
-arguments are as described in :meth:`.Signal.connect`.
+arguments are as described in :meth:`.Signal.connect`. The method returns
+``True`` if a receiver was disconnected and ``False`` if not.
-The *receiver* argument indicates the registered receiver to disconnect. It may
-be ``None`` if ``dispatch_uid`` is used to identify the receiver.
+The ``receiver`` argument indicates the registered receiver to disconnect. It
+may be ``None`` if ``dispatch_uid`` is used to identify the receiver.
+
+.. versionchanged:: 1.8
+
+ The boolean return value was added.