Slightly reword docs
remove some Note-boxes - people tend to skip these.
This commit is contained in:
parent
2d9be6dace
commit
d11c44940e
@ -719,14 +719,17 @@ class DigDeeperStrategy(IStrategy):
|
|||||||
The `adjust_entry_price()` callback may be used by strategy developer to refresh/replace limit orders upon arrival of new candles.
|
The `adjust_entry_price()` callback may be used by strategy developer to refresh/replace limit orders upon arrival of new candles.
|
||||||
Be aware that `custom_entry_price()` is still the one dictating initial entry limit order price target at the time of entry trigger.
|
Be aware that `custom_entry_price()` is still the one dictating initial entry limit order price target at the time of entry trigger.
|
||||||
|
|
||||||
!!! Note "Simple Order Cancelation"
|
Orders can ba cancelled out of this callback by returning `None`.
|
||||||
This also allows simple cancelation without an replacement order. This behavior occurs when `None` is returned.
|
|
||||||
|
|
||||||
!!! Note "Maintaining Order"
|
Returning `current_order_rate` will keep the order on the exchange "as is".
|
||||||
Maintaining existing order on exchange is facilitated. This behavior occurs when `order.price` is returned.
|
Returning any other price will cancel the existing order, and replace it with a new order.
|
||||||
|
|
||||||
!!! Warning
|
The trade open-date (`trade.open_date_utc`) will remain at the time of the very first order placed.
|
||||||
Entry `unfilledtimeout` mechanism takes precedence over this. Be sure to update timeout values to match your expectancy.
|
Please makes sure to be aware of this - and eventually adjust your logic in other callbacks to account for this, and use the date of the first filled order instead.
|
||||||
|
|
||||||
|
!!! Warning "Regular timeout"
|
||||||
|
Entry `unfilledtimeout` mechanism (as well as `check_entry_timeout()`) takes precedence over this.
|
||||||
|
Entry Orders that are cancelled via the above methods will not have this callback called. Be sure to update timeout values to match your expectations.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from freqtrade.persistence import Trade
|
from freqtrade.persistence import Trade
|
||||||
@ -741,7 +744,7 @@ class AwesomeStrategy(IStrategy):
|
|||||||
entry_tag: Optional[str], side: str, **kwargs) -> float:
|
entry_tag: Optional[str], side: str, **kwargs) -> float:
|
||||||
"""
|
"""
|
||||||
Entry price re-adjustment logic, returning the user desired limit price.
|
Entry price re-adjustment logic, returning the user desired limit price.
|
||||||
This only executes when a order was already placed, still open(unfilled fully or partially)
|
This only executes when a order was already placed, still open (unfilled fully or partially)
|
||||||
and not timed out on subsequent candles after entry trigger.
|
and not timed out on subsequent candles after entry trigger.
|
||||||
|
|
||||||
When not implemented by a strategy, returns current_order_rate as default.
|
When not implemented by a strategy, returns current_order_rate as default.
|
||||||
|
@ -813,9 +813,6 @@ class Backtesting:
|
|||||||
cost=stake_amount + trade.fee_open,
|
cost=stake_amount + trade.fee_open,
|
||||||
)
|
)
|
||||||
if pos_adjust and self._get_order_filled(order.price, row):
|
if pos_adjust and self._get_order_filled(order.price, row):
|
||||||
# Update trade open_rate on first filled order
|
|
||||||
# this is for cases where adjust_entry_order might have replaced the
|
|
||||||
# initial order from trade opening
|
|
||||||
order.close_bt_order(current_time, trade)
|
order.close_bt_order(current_time, trade)
|
||||||
else:
|
else:
|
||||||
trade.open_order_id = str(self.order_id_counter)
|
trade.open_order_id = str(self.order_id_counter)
|
||||||
|
@ -476,7 +476,7 @@ class IStrategy(ABC, HyperStrategyMixin):
|
|||||||
entry_tag: Optional[str], side: str, **kwargs) -> float:
|
entry_tag: Optional[str], side: str, **kwargs) -> float:
|
||||||
"""
|
"""
|
||||||
Entry price re-adjustment logic, returning the user desired limit price.
|
Entry price re-adjustment logic, returning the user desired limit price.
|
||||||
This only executes when a order was already placed, still open(unfilled fully or partially)
|
This only executes when a order was already placed, still open (unfilled fully or partially)
|
||||||
and not timed out on subsequent candles after entry trigger.
|
and not timed out on subsequent candles after entry trigger.
|
||||||
|
|
||||||
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
|
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
|
||||||
|
@ -35,7 +35,7 @@ def adjust_entry_price(self, trade: Trade, order: Optional[Order], pair: str,
|
|||||||
entry_tag: Optional[str], side: str, **kwargs) -> float:
|
entry_tag: Optional[str], side: str, **kwargs) -> float:
|
||||||
"""
|
"""
|
||||||
Entry price re-adjustment logic, returning the user desired limit price.
|
Entry price re-adjustment logic, returning the user desired limit price.
|
||||||
This only executes when a order was already placed, still open(unfilled fully or partially)
|
This only executes when a order was already placed, still open (unfilled fully or partially)
|
||||||
and not timed out on subsequent candles after entry trigger.
|
and not timed out on subsequent candles after entry trigger.
|
||||||
|
|
||||||
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
|
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
|
||||||
|
Loading…
Reference in New Issue
Block a user