Update documentation from --step-clients to --step-users. Adresses #1385

locustio · May 19, 2020 · 5cdc226 · 5cdc226
1 parent d043692
commit 5cdc226
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/docs/running-locust-in-step-load-mode.rst b/docs/running-locust-in-step-load-mode.rst
@@ -20,7 +20,7 @@ Options
 Enable Step Load mode to monitor how performance metrics varies when user load increases.
 
 
-``--step-clients``
+``--step-users``
 -------------------
 
 Client count to increase by step in Step Load mode. Only used together with ``--step-load``.
@@ -35,11 +35,11 @@ Step duration in Step Load mode, e.g. (300s, 20m, 3h, 1h30m, etc.). Only used to
 Running Locust in step load mode without the web UI
 ----------------------------------------------------
 
-If you want to run Locust in step load mode without the web UI, you can do that with ``--step-clients`` and ``--step-time``:
+If you want to run Locust in step load mode without the web UI, you can do that with ``--step-users`` and ``--step-time``:
 
 .. code-block:: console
 
-    $ locust -f --headless -u 1000 -r 100 --run-time 1h30m --step-load --step-clients 300 --step-time 20m
+    $ locust -f --headless -u 1000 -r 100 --run-time 1h30m --step-load --step-users 300 --step-time 20m
 
 Locust will swarm the clients by step and shutdown once the time is up.
 
@@ -48,5 +48,5 @@ Running Locust distributed in step load mode
 ---------------------------------------------
 
 If you want to :ref:`run Locust distributed <running-locust-distributed>` in step load mode, 
-you should specify the ``--step-load`` option when starting the master node, to swarm locusts by step. It will then show the ``--step-clients`` option and ``--step-time`` option in Locust UI.
+you should specify the ``--step-load`` option when starting the master node, to swarm locusts by step. It will then show the ``--step-users`` option and ``--step-time`` option in Locust UI.