Skip to content

Commit d002ee3

Browse files
committed
chore(docstring): correct helper_param() docstring returns
1 parent c140f9e commit d002ee3

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

tests/test_functionaltest.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,9 @@ def helper_param(param_name, value):
257257
Value to assign to the parameter.
258258
259259
Returns:
260-
float:
261-
Mean queue time for nurses.
260+
dict:
261+
'run' dictionary from the run_single() output, containing the
262+
average results from run/s of the model.
262263
"""
263264
# Create a default parameter, but set some specific values
264265
# (which will ensure sufficient arrivals/capacity/etc. that we will
@@ -269,7 +270,7 @@ def helper_param(param_name, value):
269270
mean_n_consult_time=15)
270271
setattr(param, param_name, value)
271272

272-
# Run replications and return the mean queue time for nurses
273+
# Run a single replication and return the results for that run
273274
experiment = Runner(param)
274275
return experiment.run_single(run=0)['run']
275276

0 commit comments

Comments
 (0)