From f0fdeba5ce1f4da74b0811b6540470749ffa7e9e Mon Sep 17 00:00:00 2001 From: Keith Lazuka Date: Mon, 7 Nov 2022 09:03:29 -0500 Subject: [PATCH] Update documentation for parsed_options arg --- locust/env.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/locust/env.py b/locust/env.py index 2d7f7947ec..5d63565a44 100644 --- a/locust/env.py +++ b/locust/env.py @@ -94,7 +94,7 @@ def __init__( If False, exceptions will be raised. """ self.parsed_options = parsed_options - """Reference to the parsed command line options (used to pre-populate fields in Web UI). May be None when using Locust as a library""" + """Reference to the parsed command line options (used to pre-populate fields in Web UI). When using Locust as a library, this should either be `None` or an object created by `argument_parser.parse_args()`""" self.available_user_classes = available_user_classes """List of the available User Classes to pick from in the UserClass Picker""" self.available_shape_classes = available_shape_classes