summaryrefslogtreecommitdiff
path: root/taskflow/conductors
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-06-25 05:29:53 +0000
committerGerrit Code Review <review@openstack.org>2015-06-25 05:29:53 +0000
commit40b8dd9bbdaebb2a95e8cb96afda2fa4a6777e37 (patch)
tree551f4984c7f54214c4ff138dde3518dbd7234471 /taskflow/conductors
parent3827fa4f654b92369ea21d2f5f020983e38a451f (diff)
parent4707bd91b64d9f7cbee89db3fca4aa00a453419c (diff)
downloadtaskflow-40b8dd9bbdaebb2a95e8cb96afda2fa4a6777e37.tar.gz
Merge "Use sphinx deprecated docstring markup"
Diffstat (limited to 'taskflow/conductors')
-rw-r--r--taskflow/conductors/backends/impl_blocking.py10
1 files changed, 6 insertions, 4 deletions
diff --git a/taskflow/conductors/backends/impl_blocking.py b/taskflow/conductors/backends/impl_blocking.py
index fb8a3c3..895f7d3 100644
--- a/taskflow/conductors/backends/impl_blocking.py
+++ b/taskflow/conductors/backends/impl_blocking.py
@@ -81,10 +81,12 @@ class BlockingConductor(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 **only**. In order to wait for
- the conductor to gracefully shut down, :meth:`wait`
- should be used instead.
+ .. deprecated:: 0.8
+
+ The ``timeout`` parameter is **deprecated** and is present for
+ backward compatibility **only**. In order to wait for the
+ conductor to gracefully shut down, :py:meth:`wait` should be used
+ instead.
"""
self._wait_timeout.interrupt()