From 16ee52d21d6835302bcd5ee594c5d6a0ef22d138 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Wed, 21 Jan 2015 19:26:51 +0100 Subject: Fixed #24205 -- Deprecated Signal.disconnect weak parameter. --- docs/internals/deprecation.txt | 3 ++- docs/releases/1.9.txt | 6 +++++- docs/topics/signals.txt | 7 ++++++- 3 files changed, 13 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index cc8548a713..250ef1f6d3 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -15,7 +15,8 @@ about each item can often be found in the release notes of two versions prior. See the :ref:`Django 1.9 release notes` for more details on these changes. -* ... +* The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` will + be removed. .. _deprecation-removed-in-2.0: diff --git a/docs/releases/1.9.txt b/docs/releases/1.9.txt index 61107583b0..a3ba70562c 100644 --- a/docs/releases/1.9.txt +++ b/docs/releases/1.9.txt @@ -177,7 +177,11 @@ Miscellaneous Features deprecated in 1.9 ========================== -... +Miscellaneous +~~~~~~~~~~~~~ + +* The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` has + been deprecated as it has no effect. .. removed-features-1.9: diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt index 7722379769..623e595daf 100644 --- a/docs/topics/signals.txt +++ b/docs/topics/signals.txt @@ -275,7 +275,7 @@ error instance is returned in the tuple pair for the receiver that raised the er Disconnecting signals ===================== -.. method:: Signal.disconnect([receiver=None, sender=None, weak=True, dispatch_uid=None]) +.. method:: Signal.disconnect([receiver=None, sender=None, dispatch_uid=None]) To disconnect a receiver from a signal, call :meth:`Signal.disconnect`. The arguments are as described in :meth:`.Signal.connect`. The method returns @@ -287,3 +287,8 @@ may be ``None`` if ``dispatch_uid`` is used to identify the receiver. .. versionchanged:: 1.8 The boolean return value was added. + +.. deprecated:: 1.9 + + The ``weak`` argument is deprecated as it has no effect. It will be removed + in Django 2.1. -- cgit v1.3