Skip to content

Commit cbf27f0

Browse files
committed
docs: Simplify doc examples
1 parent fed91ff commit cbf27f0

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/strategy-callbacks.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@ Returning `None` will be interpreted as "no desire to change", and is the only s
178178

179179
Stoploss on exchange works similar to `trailing_stop`, and the stoploss on exchange is updated as configured in `stoploss_on_exchange_interval` ([More details about stoploss on exchange](stoploss.md#stop-loss-on-exchangefreqtrade)).
180180

181+
If you're on futures markets, please take note of the [stoploss and leverage](stoploss.md#stoploss-and-leverage) section, as the stoploss value returned from `custom_stoploss` is the risk for this trade - not the relative price movement.
182+
181183
!!! Note "Use of dates"
182184
All time-based calculations should be done based on `current_time` - using `datetime.now()` or `datetime.utcnow()` is discouraged, as this will break backtesting support.
183185

@@ -233,7 +235,7 @@ class AwesomeStrategy(IStrategy):
233235
:param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
234236
:return float: New stoploss value, relative to the current_rate
235237
"""
236-
return -0.04 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
238+
return -0.04 * trade.leverage
237239
```
238240

239241
#### Time based trailing stop
@@ -255,9 +257,9 @@ class AwesomeStrategy(IStrategy):
255257

256258
# Make sure you have the longest interval first - these conditions are evaluated from top to bottom.
257259
if current_time - timedelta(minutes=120) > trade.open_date_utc:
258-
return -0.05 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
260+
return -0.05 * trade.leverage
259261
elif current_time - timedelta(minutes=60) > trade.open_date_utc:
260-
return -0.10 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
262+
return -0.10 * trade.leverage
261263
return None
262264
```
263265

@@ -284,9 +286,9 @@ class AwesomeStrategy(IStrategy):
284286
return stoploss_from_open(0.10, current_profit, is_short=trade.is_short, leverage=trade.leverage)
285287
# Make sure you have the longest interval first - these conditions are evaluated from top to bottom.
286288
if current_time - timedelta(minutes=120) > trade.open_date_utc:
287-
return -0.05 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
289+
return -0.05 * trade.leverage
288290
elif current_time - timedelta(minutes=60) > trade.open_date_utc:
289-
return -0.10 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
291+
return -0.10 * trade.leverage
290292
return None
291293
```
292294

@@ -309,10 +311,10 @@ class AwesomeStrategy(IStrategy):
309311
**kwargs) -> float | None:
310312

311313
if pair in ("ETH/BTC", "XRP/BTC"):
312-
return -0.10 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
314+
return -0.10 * trade.leverage
313315
elif pair in ("LTC/BTC"):
314-
return -0.05 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
315-
return -0.15 * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
316+
return -0.05 * trade.leverage
317+
return -0.15 * trade.leverage
316318
```
317319

318320
#### Trailing stoploss with positive offset
@@ -341,7 +343,7 @@ class AwesomeStrategy(IStrategy):
341343
desired_stoploss = current_profit / 2
342344

343345
# Use a minimum of 2.5% and a maximum of 5%
344-
return max(min(desired_stoploss, 0.05), 0.025) * trade.leverage # if your leverage level is 1 or spot trading trade.leverage multiplier can be void.
346+
return max(min(desired_stoploss, 0.05), 0.025) * trade.leverage
345347
```
346348

347349
#### Stepped stoploss
@@ -368,7 +370,7 @@ class AwesomeStrategy(IStrategy):
368370

369371
# evaluate highest to lowest, so that highest possible stop is used
370372
if current_profit > 0.40:
371-
return stoploss_from_open(0.25, current_profit, is_short=trade.is_short, leverage=trade.leverage)
373+
return stoploss_from_open(0.25, current_profit, is_short=trade.is_short, leverage=trade.leverage)
372374
elif current_profit > 0.25:
373375
return stoploss_from_open(0.15, current_profit, is_short=trade.is_short, leverage=trade.leverage)
374376
elif current_profit > 0.20:

0 commit comments

Comments
 (0)