Add docstring describing the inject instance variable

Change-Id: I00c48fc6a5f579fe72badc034fbd293f2eb41d5c
This commit is contained in:
Joshua Harlow
2014-05-29 14:17:04 -07:00
parent ef9bf8320a
commit c9ab8b2931

View File

@@ -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):