Skip to content

Commit

Permalink
Add deprecation notes to docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
heyman committed Oct 24, 2019
1 parent d33fac4 commit af92687
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions locust/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ class Locust(object):
"""Base hostname to swarm. i.e: http://127.0.0.1:1234"""

min_wait = None
"""Minimum waiting time between the execution of locust tasks"""
"""Deprecated: Use wait_time instead. Minimum waiting time between the execution of locust tasks"""

max_wait = None
"""Maximum waiting time between the execution of locust tasks"""
"""Deprecated: Use wait_time instead. Maximum waiting time between the execution of locust tasks"""

wait_time = None
"""
Expand Down Expand Up @@ -297,20 +297,23 @@ class ForumPage(TaskSet):

min_wait = None
"""
Deprecated: Use wait_time instead.
Minimum waiting time between the execution of locust tasks. Can be used to override
the min_wait defined in the root Locust class, which will be used if not set on the
TaskSet.
"""

max_wait = None
"""
Deprecated: Use wait_time instead.
Maximum waiting time between the execution of locust tasks. Can be used to override
the max_wait defined in the root Locust class, which will be used if not set on the
TaskSet.
"""

wait_function = None
"""
Deprecated: Use wait_time instead.
Function used to calculate waiting time betwen the execution of locust tasks in milliseconds.
Can be used to override the wait_function defined in the root Locust class, which will be used
if not set on the TaskSet.
Expand Down

0 comments on commit af92687

Please sign in to comment.