From 9887aefb0387aaf86084e510d13b923904ebe961 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Thu, 29 May 2014 14:17:04 -0700 Subject: [PATCH] Add docstring describing the inject instance variable Change-Id: I00c48fc6a5f579fe72badc034fbd293f2eb41d5c --- taskflow/atom.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/taskflow/atom.py b/taskflow/atom.py index e3ed8b34..58f69f8d 100644 --- a/taskflow/atom.py +++ b/taskflow/atom.py @@ -134,6 +134,11 @@ class Atom(object): the names that this atom expects (in a way this is like remapping a namespace of another atom into the namespace of this atom). + :ivar inject: An *immutable* input_name => value dictionary which specifies + any initial inputs that should be automatically injected into + the atoms scope before the atom execution commences (this + allows for providing atom *local* values that do not need to + be provided by other atoms). """ def __init__(self, name=None, provides=None, inject=None):