Skip to content

Commit 754964f

Browse files
committed
missed one docstring
1 parent 9c58a46 commit 754964f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

hamilton/function_modifiers/macros.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,6 +1113,15 @@ def __init__(
11131113
_chain: bool = False,
11141114
**mutating_function_kwargs: Union[SingleDependency, Any],
11151115
):
1116+
"""Instantiates a `@mutate` decorator.
1117+
1118+
We assume the first argument of the decorated function to be the output of the function we are targeting.
1119+
1120+
:param target_functions: functions we wish to mutate the output of
1121+
:param collapse: Whether to collapse this into a single node. This is not currently supported.
1122+
:param _chain: Whether to chain the first parameter. This is the only mode that is supported. Furthermore, this is not externally exposed. @flow will make use of this.
1123+
:param **mutating_function_kwargs: other kwargs that the decorated function has
1124+
"""
11161125
self.collapse = collapse
11171126
self.chain = _chain
11181127
# keeping it here once it gets implemented maybe nice to have options

0 commit comments

Comments
 (0)