Merge pull request #46 from tillahoffmann/apply

Clarify inplace modification of context (fixes #43).

pythonflow/core.py

@@ -82,6 +82,10 @@ def normalize_context(self, context, **kwargs):
         """
         Normalize a context by replacing all operation names with operation instances.
 
+        .. note::
+           This function modifies the context in place. Use :code:`context=context.copy()` to avoid
+           the context being modified.
+
         Parameters
         ----------
         context : dict[Operation or str, object]
@@ -127,6 +131,10 @@ def apply(self, fetches, context=None, *, callback=None, **kwargs):
         """
         Evaluate one or more operations given a context.
 
+        .. note::
+           This function modifies the context in place. Use :code:`context=context.copy()` to avoid
+           the context being modified.
+
         Parameters
         ----------
         fetches : list[str or Operation] or str or Operation

pythonflow/operations.py

@@ -41,8 +41,9 @@ class conditional(Operation):  # pylint: disable=C0103,W0223
     """
     Return `x` if `predicate` is `True` and `y` otherwise.
 
-    Note that the conditional operation will only execute one branch of the computation graph
-    depending on `predicate`.
+    .. note::
+        The conditional operation will only execute one branch of the computation graph depending on
+        `predicate`.
     """
     def __init__(self, predicate, x, y=None, *, length=None, name=None, dependencies=None):  # pylint: disable=W0235
         super(conditional, self).__init__(predicate, x, y,
@@ -67,7 +68,8 @@ class try_(Operation):  # pylint: disable=C0103,W0223
     Try to evaluate `operation`, fall back to alternative operations in `except_`, and ensure that
     `finally_` is evaluated.
 
-    Note that the alternative operations will only be executed if the target operation fails.
+    .. note::
+        The alternative operations will only be executed if the target operation fails.
 
     Parameters
     ----------