Fix documentation related to missing BaseTask class
The docs no longer matched reality. Change-Id: I9ee98e16fc03489569bbed8355416a73f7bc02ff Closes-Bug: 1579890
This commit is contained in:
parent
afbfe77a7f
commit
5944ccc020
|
@ -2,12 +2,12 @@
|
|||
Arguments and results
|
||||
=====================
|
||||
|
||||
.. |task.execute| replace:: :py:meth:`~taskflow.task.BaseTask.execute`
|
||||
.. |task.revert| replace:: :py:meth:`~taskflow.task.BaseTask.revert`
|
||||
.. |task.execute| replace:: :py:meth:`~taskflow.atom.Atom.execute`
|
||||
.. |task.revert| replace:: :py:meth:`~taskflow.atom.Atom.revert`
|
||||
.. |retry.execute| replace:: :py:meth:`~taskflow.retry.Retry.execute`
|
||||
.. |retry.revert| replace:: :py:meth:`~taskflow.retry.Retry.revert`
|
||||
.. |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
|
||||
(see :doc:`persistence <persistence>` for more details). That includes all the
|
||||
|
|
|
@ -23,10 +23,10 @@ values (requirements) and name outputs (provided values).
|
|||
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
|
||||
it (they are *nearly* analogous to functions). These task objects all derive
|
||||
from :py:class:`~taskflow.task.BaseTask` which defines what a task must
|
||||
it (they are *nearly* analogous to functions). Your task objects should all
|
||||
derive from :py:class:`~taskflow.task.Task` which defines what a task must
|
||||
provide in terms of properties and methods.
|
||||
|
||||
**For example:**
|
||||
|
|
|
@ -62,7 +62,7 @@ task.
|
|||
.. note::
|
||||
|
||||
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.
|
||||
|
||||
------------------
|
||||
|
|
|
@ -132,30 +132,30 @@ the ``IGNORE`` state.
|
|||
|
||||
**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
|
||||
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.
|
||||
|
||||
**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
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
raises an exception), the task goes to the ``REVERT_FAILURE`` 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
|
||||
during running its :py:meth:`~taskflow.task.BaseTask.revert` method).
|
||||
during running its :py:meth:`~taskflow.atom.Atom.revert` method).
|
||||
|
||||
Retry
|
||||
=====
|
||||
|
|
|
@ -704,7 +704,7 @@ class AtomDetail(object):
|
|||
class TaskDetail(AtomDetail):
|
||||
"""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):
|
||||
|
|
Loading…
Reference in New Issue