openstack/deb-python-taskflow
Code Issues Proposed changes

Fix documentation related to missing BaseTask class

Browse Source 
The docs no longer matched reality.

Change-Id: I9ee98e16fc03489569bbed8355416a73f7bc02ff
Closes-Bug: 1579890
This commit is contained in:
Greg Hill
2016-05-10 09:06:27 -05:00
committed by Joshua Harlow
parent afbfe77a7f
commit 5944ccc020
5 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/arguments_and_results.rst
View File

@@ -2,12 +2,12 @@
Arguments and results Arguments and results
===================== =====================
.. |task.execute| replace:: :py:meth:`~taskflow.task.BaseTask.execute` .. |task.execute| replace:: :py:meth:`~taskflow.atom.Atom.execute`
.. |task.revert| replace:: :py:meth:`~taskflow.task.BaseTask.revert` .. |task.revert| replace:: :py:meth:`~taskflow.atom.Atom.revert`
.. |retry.execute| replace:: :py:meth:`~taskflow.retry.Retry.execute` .. |retry.execute| replace:: :py:meth:`~taskflow.retry.Retry.execute`
.. |retry.revert| replace:: :py:meth:`~taskflow.retry.Retry.revert` .. |retry.revert| replace:: :py:meth:`~taskflow.retry.Retry.revert`
.. |Retry| replace:: :py:class:`~taskflow.retry.Retry` .. |Retry| replace:: :py:class:`~taskflow.retry.Retry`
.. |Task| replace:: :py:class:`Task <taskflow.task.BaseTask>` .. |Task| replace:: :py:class:`Task <taskflow.task.Task>`
In TaskFlow, all flow and task state goes to (potentially persistent) storage In TaskFlow, all flow and task state goes to (potentially persistent) storage
(see :doc:`persistence <persistence>` for more details). That includes all the (see :doc:`persistence <persistence>` for more details). That includes all the

6
doc/source/atoms.rst
View File

@@ -23,10 +23,10 @@ values (requirements) and name outputs (provided values).
Task Task
===== =====
A :py:class:`task <taskflow.task.BaseTask>` (derived from an atom) is a A :py:class:`task <taskflow.task.Task>` (derived from an atom) is a
unit of work that can have an execute & rollback sequence associated with unit of work that can have an execute & rollback sequence associated with
it (they are *nearly* analogous to functions). These task objects all derive it (they are *nearly* analogous to functions). Your task objects should all
from :py:class:`~taskflow.task.BaseTask` which defines what a task must derive from :py:class:`~taskflow.task.Task` which defines what a task must
provide in terms of properties and methods. provide in terms of properties and methods.
**For example:** **For example:**

2
doc/source/inputs_and_outputs.rst
View File

@@ -62,7 +62,7 @@ task.
.. note:: .. note::
There is no difference between processing of There is no difference between processing of
:py:class:`Task <taskflow.task.BaseTask>` and :py:class:`Task <taskflow.task.Task>` and
:py:class:`~taskflow.retry.Retry` inputs and outputs. :py:class:`~taskflow.retry.Retry` inputs and outputs.
------------------ ------------------

12
doc/source/states.rst
View File

@@ -132,30 +132,30 @@ the ``IGNORE`` state.
**RUNNING** - When an engine running the task starts to execute the task, the **RUNNING** - When an engine running the task starts to execute the task, the
engine will transition the task to the ``RUNNING`` state, and the task will engine will transition the task to the ``RUNNING`` state, and the task will
stay in this state until the tasks :py:meth:`~taskflow.task.BaseTask.execute` stay in this state until the tasks :py:meth:`~taskflow.atom.Atom.execute`
method returns. method returns.
**SUCCESS** - The engine running the task transitions the task to this state **SUCCESS** - The engine running the task transitions the task to this state
after the task has finished successfully (ie no exception/s were raised during after the task has finished successfully (ie no exception/s were raised during
running its :py:meth:`~taskflow.task.BaseTask.execute` method). running its :py:meth:`~taskflow.atom.Atom.execute` method).
**FAILURE** - The engine running the task transitions the task to this state **FAILURE** - The engine running the task transitions the task to this state
after it has finished with an error (ie exception/s were raised during after it has finished with an error (ie exception/s were raised during
running its :py:meth:`~taskflow.task.BaseTask.execute` method). running its :py:meth:`~taskflow.atom.Atom.execute` method).
**REVERT_FAILURE** - The engine running the task transitions the task to this **REVERT_FAILURE** - The engine running the task transitions the task to this
state after it has finished with an error (ie exception/s were raised during state after it has finished with an error (ie exception/s were raised during
running its :py:meth:`~taskflow.task.BaseTask.revert` method). running its :py:meth:`~taskflow.atom.Atom.revert` method).
**REVERTING** - The engine running a task transitions the task to this state **REVERTING** - The engine running a task transitions the task to this state
when the containing flow the engine is running starts to revert and when the containing flow the engine is running starts to revert and
its :py:meth:`~taskflow.task.BaseTask.revert` method is called. Only tasks in its :py:meth:`~taskflow.atom.Atom.revert` method is called. Only tasks in
the ``SUCCESS`` or ``FAILURE`` state can be reverted. If this method fails (ie the ``SUCCESS`` or ``FAILURE`` state can be reverted. If this method fails (ie
raises an exception), the task goes to the ``REVERT_FAILURE`` state. raises an exception), the task goes to the ``REVERT_FAILURE`` state.
**REVERTED** - The engine running the task transitions the task to this state **REVERTED** - The engine running the task transitions the task to this state
after it has successfully reverted the task (ie no exception/s were raised after it has successfully reverted the task (ie no exception/s were raised
during running its :py:meth:`~taskflow.task.BaseTask.revert` method). during running its :py:meth:`~taskflow.atom.Atom.revert` method).
Retry Retry
===== =====

2
taskflow/persistence/models.py
View File

@@ -704,7 +704,7 @@ class AtomDetail(object):
class TaskDetail(AtomDetail): class TaskDetail(AtomDetail):
"""A task detail (an atom detail typically associated with a |tt| atom). """A task detail (an atom detail typically associated with a |tt| atom).
.. |tt| replace:: :py:class:`~taskflow.task.BaseTask` .. |tt| replace:: :py:class:`~taskflow.task.Task`
""" """
def reset(self, state): def reset(self, state):