Skip to content

Commit 755b72a

Browse files
committed
Add missing end_time_goal and duration_goal to doc-string
1 parent e2d4203 commit 755b72a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

adaptive/runner.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,15 @@ class BlockingRunner(BaseRunner):
366366
Convenience argument, use instead of ``goal``. The end condition for the
367367
calculation. Stop when the number of points is larger or
368368
equal than this value.
369+
end_time_goal : datetime, optional
370+
Convenience argument, use instead of ``goal``. The end condition for the
371+
calculation. Stop when the current time is larger or equal than this
372+
value.
373+
duration_goal : timedelta or number, optional
374+
Convenience argument, use instead of ``goal``. The end condition for the
375+
calculation. Stop when the current time is larger or equal than
376+
``start_time + duration_goal``. ``duration_goal`` can be a number
377+
indicating the number of seconds
369378
executor : `concurrent.futures.Executor`, `distributed.Client`,\
370379
`mpi4py.futures.MPIPoolExecutor`, `ipyparallel.Client` or\
371380
`loky.get_reusable_executor`, optional

0 commit comments

Comments
 (0)