Skip to content

Commit 95fc245

Browse files
committed
DOC: Improve docstring
skipci
1 parent fb3444d commit 95fc245

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

octue/resources/child.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ def ask_multiple(
148148
:param bool raise_errors: if `True`, an error is raised and no answers are returned if any of the individual questions raise an error; if `False`, answers are returned for all successful questions while errors are returned unraised for any failed ones
149149
:param int max_retries: retry any questions that failed up to this number of times (note: this will have no effect unless `raise_errors=False`)
150150
:param list(type)|None prevent_retries_when: prevent retrying any questions that fail with an exception type in this list (note: this will have no effect unless `raise_errors=False`)
151-
:param int|None max_workers: the maximum number of questions that can be asked at once; defaults to `min(32, os.cpu_count() + 4, len(questions))` (see `concurrent.futures.ThreadPoolExecutor`)
151+
:param int|None max_workers: the maximum number of questions that can be asked at once; defaults to the lowest of {32, no. of CPUs + 4, and no. of questions} (see `concurrent.futures.ThreadPoolExecutor`)
152152
:param bool log_errors: if `True` and `raise_errors=False`, log any errors remaining once retries are exhausted
153153
:raise ValueError: if the maximum number of parallel questions is set too high
154154
:raise Exception: if any question raises an error if `raise_errors` is `True`

0 commit comments

Comments
 (0)