summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-02-14 06:34:15 +0000
committerGerrit Code Review <review@openstack.org>2015-02-14 06:34:15 +0000
commit7b0260692f52c48a8b138ad1b39e4b89523a0f0a (patch)
tree384d9c6837f7fac11ca54c3c246d37ce25e8b2b2
parent517dc1f4316a5bbca96df3714646f2fef0aff2eb (diff)
parent0bcd1eb863854a64540ce21fe081af9e16167266 (diff)
downloadtaskflow-7b0260692f52c48a8b138ad1b39e4b89523a0f0a.tar.gz
Merge "Mark conductor 'stop' method deprecation kwarg with versions"
-rw-r--r--taskflow/conductors/single_threaded.py11
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()