Skip to content

Commit ce7d813

Browse files
committed
chore: improved docstring for skdecimal
1 parent 7cfecab commit ce7d813

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

freqtrade/optimize/space/decimalspace.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,19 @@ def __init__(
66
self,
77
low: float,
88
high: float,
9+
*,
910
step: float | None = None,
1011
decimals: int = 3,
1112
name=None,
1213
):
1314
"""
1415
FloatDistribution with a fixed step size.
16+
Only one of step or decimals can be set.
17+
:param low: lower bound
18+
:param high: upper bound
19+
:param step: step size (e.g. 0.001)
20+
:param decimals: number of decimal places to round to (e.g. 3)
21+
:param name: name of the distribution
1522
"""
1623
if decimals is not None and step is not None:
1724
raise ValueError("You can only set one of decimals or step")

0 commit comments

Comments
 (0)