diff options
author | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-02-12 17:26:41 -0800 |
---|---|---|
committer | Joshua Harlow <harlowja@gmail.com> | 2015-02-12 20:50:42 -0800 |
commit | 0bcd1eb863854a64540ce21fe081af9e16167266 (patch) | |
tree | 318f906d88cd90680700afc4ffe27640943e3ae0 | |
parent | f11f7bbda725578312be53a8baf174715e1f80bd (diff) | |
download | taskflow-0bcd1eb863854a64540ce21fe081af9e16167266.tar.gz |
Mark conductor 'stop' method deprecation kwarg with versions
To make it known (when the warning message is emitted) what
version this was deprecated in and when it may be removed
in add those parameters to the 'removed_kwarg' decorator so that
users of conductors are aware of this information.
Change-Id: Iacc97831ccd96d68cea4bd7e65a967b5ff9e7dc5
-rw-r--r-- | taskflow/conductors/single_threaded.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/taskflow/conductors/single_threaded.py b/taskflow/conductors/single_threaded.py index 126917f..2304514 100644 --- a/taskflow/conductors/single_threaded.py +++ b/taskflow/conductors/single_threaded.py @@ -65,7 +65,8 @@ class SingleThreadedConductor(base.Conductor): raise ValueError("Invalid timeout literal: %s" % (wait_timeout)) self._dead = threading_utils.Event() - @deprecation.removed_kwarg('timeout') + @deprecation.removed_kwarg('timeout', + version="0.8", removal_version="?") def stop(self, timeout=None): """Requests the conductor to stop dispatching. @@ -75,10 +76,10 @@ class SingleThreadedConductor(base.Conductor): The method returns immediately regardless of whether the conductor has been stopped. - :param timeout: This parameter is deprecated and is present for - backward compatibility. In order to wait for the - conductor to gracefully shut down, :meth:`wait` should - be used. + :param timeout: This parameter is **deprecated** and is present for + backward compatibility **only**. In order to wait for + the conductor to gracefully shut down, :meth:`wait` + should be used instead. """ self._wait_timeout.interrupt() |