Skip to content

Commit

Permalink
Merge pull request #2247 from klazuka/klazuka/env-docs-parsed-options
Browse files Browse the repository at this point in the history
Update documentation for Environment.parsed_options
  • Loading branch information
cyberw committed Nov 7, 2022
2 parents 980de8d + f0fdeba commit 2439e61
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion locust/env.py
Expand Up @@ -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
Expand Down

0 comments on commit 2439e61

Please sign in to comment.