Skip to content

Commit 7c7516d

Browse files
authored
Tweak docstring (#662)
1 parent badbb9e commit 7c7516d

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

temporalio/workflow.py

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -150,19 +150,11 @@ def init(
150150
151151
This may be used on the __init__ method of the workflow class to specify
152152
that it accepts the same workflow input arguments as the ``@workflow.run``
153-
method. It may not be used on any other method.
154-
155-
If used, the workflow will be instantiated as
156-
``MyWorkflow(**workflow_input_args)``. If not used, the workflow will be
157-
instantiated as ``MyWorkflow()``.
158-
159-
Note that the ``@workflow.run`` method is always called as
160-
``my_workflow.my_run_method(**workflow_input_args)``. If you use the
161-
``@workflow.init`` decorator, the parameter list of your __init__ and
162-
``@workflow.run`` methods must be identical.
153+
method. If used, the parameters of your __init__ and ``@workflow.run``
154+
methods must be identical.
163155
164156
Args:
165-
init_fn: The __init__function to decorate.
157+
init_fn: The __init__ method to decorate.
166158
"""
167159
if init_fn.__name__ != "__init__":
168160
raise ValueError("@workflow.init may only be used on the __init__ method")

0 commit comments

Comments
 (0)