openstack/deb-python-taskflow
Code Issues Proposed changes

Merge "Mark conductor 'stop' method deprecation kwarg with versions"

Browse Source
This commit is contained in:
Jenkins
2015-02-14 06:34:15 +00:00
committed by Gerrit Code Review
parent 517dc1f431 0bcd1eb863
commit 7b0260692f
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
taskflow/conductors/single_threaded.py
View File

@@ -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()