Skip to content

Commit 7241d61

Browse files
authored
fixed ordered list in markdown and fixed error in __init__ argument description
1 parent dc2ffce commit 7241d61

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

hamilton/function_modifiers/delayed.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,16 @@ def summation(s1: pd.Series, s2: pd.Series) -> pd.Series:
8787
return s1 + s2
8888
8989
Note how this works:
90+
9091
1. The `decorate_with` argument is a function that gives you the decorator you want to apply.
9192
Currently its "hamilton-esque" -- while we do not require it to be typed, you can use a separate
9293
configuration-reoslver function (and include type information). This lambda function must return
9394
a decorator.
95+
9496
2. The `when` argument is the point at which you want to resolve the decorator. Currently, we
9597
only support `ResolveAt.CONFIG_AVAILABLE`, which means that the decorator will be resolved at compile
9698
time, E.G. when the driver is instantiated.
99+
97100
3. This is then run and dynamically resolved.
98101
99102
This is powerful, but the code is uglier. It's meant to be used in some very specific cases,
@@ -112,7 +115,7 @@ def __init__(self, *, when: ResolveAt, decorate_with: Callable[..., NodeTransfor
112115
"""Initializes a delayed decorator that gets called at some specific resolution time.
113116
114117
:param decorate_with: Function that takes required and optional parameters/returns a decorator.
115-
:param until: When to resolve the decorator. Currently only supports `ResolveAt.CONFIG_AVAILABLE`.
118+
:param when: When to resolve the decorator. Currently only supports `ResolveAt.CONFIG_AVAILABLE`.
116119
"""
117120
if when != ResolveAt.CONFIG_AVAILABLE:
118121
raise ValueError("Dynamic functions must be configured at config time!")

0 commit comments

Comments
 (0)