Skip to content

Commit

Permalink
Update custom-load-shape.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberw committed May 8, 2024
1 parent a225ef3 commit c861a74
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/custom-load-shape.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This shape would create create in the first 10 seconds 10 User of ``UserA``. In
Reusing common options in custom shapes
---------------------------------------

By default the *Users*, *Spawn Rate* and *Run Time* options will be hidden from the UI, and if you specify them on command line Locust will log a warning. This is because those options dont directly apply to shapes, and specifying them is most often a mistake.
When using shapes, the the *Users*, *Spawn Rate* and *Run Time* options will be hidden from the UI, and if you specify them on command line Locust will log a warning. This is because those options dont directly apply to shapes, and specifying them might be a mistake.

If you really want to combine a shape with these options, set the ``use_common_options`` attribute and access them from ``self.runner.environment.parsed_options``:

Expand Down

0 comments on commit c861a74

Please sign in to comment.