chore: slightly improve docstring

This commit is contained in:
Matthias
2026-02-01 16:50:57 +01:00
parent 93b6c52aad
commit cedfb2a51f

View File

@@ -1208,7 +1208,7 @@ class LocalTrade:
def calc_close_rate_for_roi(self, target_roi: float) -> float:
"""
Calculate the required close price to reach a target ROI.
Matches the logic used in `calc_profit_ratio()`.
Must match the logic used in `calc_profit_ratio()`.
:param target_roi: The desired return on investment (as a decimal, e.g., 0.05 for 5%)
:return: Close price (rate) required to achieve the target ROI