diff options
| -rw-r--r-- | setup.cfg | 1 | ||||
| -rw-r--r-- | taskflow/atom.py | 2 | ||||
| -rw-r--r-- | taskflow/engines/base.py | 6 | ||||
| -rw-r--r-- | taskflow/persistence/models.py | 2 | ||||
| -rw-r--r-- | taskflow/types/entity.py | 2 |
5 files changed, 8 insertions, 5 deletions
@@ -99,6 +99,7 @@ universal = 1 source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html diff --git a/taskflow/atom.py b/taskflow/atom.py index a1e9b28..8dcc6dc 100644 --- a/taskflow/atom.py +++ b/taskflow/atom.py @@ -211,7 +211,7 @@ class Atom(object): method has a different signature from ``execute`` or a different ``revert_rebind`` value was received. :ivar inject: See parameter ``inject``. - :ivar name: See parameter ``name``. + :ivar Atom.name: See parameter ``name``. :ivar requires: A :py:class:`~taskflow.types.sets.OrderedSet` of inputs this atom requires to function. :ivar optional: A :py:class:`~taskflow.types.sets.OrderedSet` of inputs diff --git a/taskflow/engines/base.py b/taskflow/engines/base.py index 0e76071..84d227e 100644 --- a/taskflow/engines/base.py +++ b/taskflow/engines/base.py @@ -27,10 +27,12 @@ from taskflow.utils import misc class Engine(object): """Base for all engines implementations. - :ivar notifier: A notification object that will dispatch events that - occur related to the flow the engine contains. + :ivar Engine.notifier: A notification object that will dispatch + events that occur related to the flow the engine + contains. :ivar atom_notifier: A notification object that will dispatch events that occur related to the atoms the engine contains. + """ def __init__(self, flow, flow_detail, backend, options): diff --git a/taskflow/persistence/models.py b/taskflow/persistence/models.py index 7b08f4e..3106240 100644 --- a/taskflow/persistence/models.py +++ b/taskflow/persistence/models.py @@ -500,7 +500,7 @@ class AtomDetail(object): ``execute`` method or from other sources. :ivar revert_results: Any results the atom produced from either its ``revert`` method or from other sources. - :ivar failure: If the atom failed (due to its ``execute`` method + :ivar AtomDetail.failure: If the atom failed (due to its ``execute`` method raising) this will be a :py:class:`~taskflow.types.failure.Failure` object that represents that failure (if there was no failure this diff --git a/taskflow/types/entity.py b/taskflow/types/entity.py index a644277..de336cc 100644 --- a/taskflow/types/entity.py +++ b/taskflow/types/entity.py @@ -21,7 +21,7 @@ class Entity(object): :ivar kind: **immutable** type/kind that identifies this entity (typically unique to a library/application) :type kind: string - :ivar name: **immutable** name that can be used to uniquely + :ivar Entity.name: **immutable** name that can be used to uniquely identify this entity among many other entities :type name: string :ivar metadata: **immutable** dictionary of metadata that is |