Merge "Use sphinx deprecated docstring markup"

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
+        .. deprecated:: 0.8
-                        backward compatibility **only**. In order to wait for
+
-                        the conductor to gracefully shut down, :meth:`wait`
+            The ``timeout`` parameter is **deprecated** and is present for
-                        should be used instead.
+            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()
 

taskflow/engines/base.py

@@ -57,7 +57,15 @@ class Engine(object):
     @moves.moved_property('atom_notifier', version="0.6",
                           removal_version="?")
     def task_notifier(self):
-        """The task notifier."""
+        """The task notifier.
+
+        .. deprecated:: 0.6
+
+            The property is **deprecated** and is present for
+            backward compatibility **only**. In order to access this
+            property going forward the :py:attr:`.atom_notifier` should
+            be used instead.
+        """
         return self._atom_notifier
 
     @property

taskflow/engines/helpers.py

@@ -146,6 +146,13 @@ def load(flow, store=None, flow_detail=None, book=None,
     :py:func:`~taskflow.persistence.backends.fetch` to obtain a
     viable backend.
 
+    .. deprecated:: 0.6
+
+        The ``engine_conf`` argument is **deprecated** and is present
+        for backward compatibility **only**. In order to provide this
+        argument going forward the ``engine`` string (or URI) argument
+        should be used instead.
+
     :param flow: flow to load
     :param store: dict -- data to put to storage to satisfy flow requirements
     :param flow_detail: FlowDetail that holds the state of the flow (if one is
@@ -199,6 +206,13 @@ def run(flow, store=None, flow_detail=None, book=None,
 
     The arguments are interpreted as for :func:`load() <load>`.
 
+    .. deprecated:: 0.6
+
+        The ``engine_conf`` argument is **deprecated** and is present
+        for backward compatibility **only**. In order to provide this
+        argument going forward the ``engine`` string (or URI) argument
+        should be used instead.
+
     :returns: dictionary of all named
               results (see :py:meth:`~.taskflow.storage.Storage.fetch_all`)
     """
@@ -264,6 +278,13 @@ def load_from_factory(flow_factory, factory_args=None, factory_kwargs=None,
 
     Further arguments are interpreted as for :func:`load() <load>`.
 
+    .. deprecated:: 0.6
+
+        The ``engine_conf`` argument is **deprecated** and is present
+        for backward compatibility **only**. In order to provide this
+        argument going forward the ``engine`` string (or URI) argument
+        should be used instead.
+
     :returns: engine
     """
 
@@ -324,6 +345,13 @@ def load_from_detail(flow_detail, store=None, engine_conf=None, backend=None,
 
     Further arguments are interpreted as for :func:`load() <load>`.
 
+    .. deprecated:: 0.6
+
+        The ``engine_conf`` argument is **deprecated** and is present
+        for backward compatibility **only**. In order to provide this
+        argument going forward the ``engine`` string (or URI) argument
+        should be used instead.
+
     :returns: engine
     """
     flow = flow_from_detail(flow_detail)

taskflow/listeners/base.py

@@ -215,6 +215,15 @@ class LoggingBase(moves.moved_class(DumpingListener,
                                     'LoggingBase', __name__,
                                     version="0.6", removal_version="?")):
 
+    """Legacy logging base.
+
+     .. deprecated:: 0.6
+
+         This class is **deprecated** and is present for backward
+         compatibility **only**, its replacement
+         :py:class:`.DumpingListener` should be used going forward.
+    """
+
     def _dump(self, message, *args, **kwargs):
         self._log(message, *args, **kwargs)