From b545fc5590f03d84ba7aa5eaadba8b9aca896a70 Mon Sep 17 00:00:00 2001 From: Mart van de Ven Date: Thu, 20 Apr 2023 13:36:14 +0800 Subject: [PATCH 1/2] Correct user namespace from `cust_` to `custom_` --- docs/strategy-advanced.md | 2 +- docs/strategy-callbacks.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/strategy-advanced.md b/docs/strategy-advanced.md index cbb71e810..b38bd1c3f 100644 --- a/docs/strategy-advanced.md +++ b/docs/strategy-advanced.md @@ -15,7 +15,7 @@ If you're just getting started, please be familiar with the methods described in Storing information can be accomplished by creating a new dictionary within the strategy class. -The name of the variable can be chosen at will, but should be prefixed with `cust_` to avoid naming collisions with predefined strategy variables. +The name of the variable can be chosen at will, but should be prefixed with `custom_` to avoid naming collisions with predefined strategy variables. ```python class AwesomeStrategy(IStrategy): diff --git a/docs/strategy-callbacks.md b/docs/strategy-callbacks.md index a13bdfd02..855f2353b 100644 --- a/docs/strategy-callbacks.md +++ b/docs/strategy-callbacks.md @@ -43,7 +43,7 @@ class AwesomeStrategy(IStrategy): if self.config['runmode'].value in ('live', 'dry_run'): # Assign this to the class by using self.* # can then be used by populate_* methods - self.cust_remote_data = requests.get('https://some_remote_source.example.com') + self.custom_remote_data = requests.get('https://some_remote_source.example.com') ``` From 818da02f6ca8c81a8b476d9065dba65390611603 Mon Sep 17 00:00:00 2001 From: Mart van de Ven Date: Thu, 20 Apr 2023 14:01:01 +0800 Subject: [PATCH 2/2] Edit `Advanced Strategies` intro for clarify and brevity --- docs/strategy-advanced.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/strategy-advanced.md b/docs/strategy-advanced.md index b38bd1c3f..a93dcecdf 100644 --- a/docs/strategy-advanced.md +++ b/docs/strategy-advanced.md @@ -1,15 +1,15 @@ # Advanced Strategies This page explains some advanced concepts available for strategies. -If you're just getting started, please be familiar with the methods described in the [Strategy Customization](strategy-customization.md) documentation and with the [Freqtrade basics](bot-basics.md) first. +If you're just getting started, please familiarize yourself with the [Freqtrade basics](bot-basics.md) and methods described in [Strategy Customization](strategy-customization.md) first. -[Freqtrade basics](bot-basics.md) describes in which sequence each method described below is called, which can be helpful to understand which method to use for your custom needs. +The call sequence of the methods described here is covered under [bot execution logic](bot-basics.md#bot-execution-logic). Those docs are also helpful in deciding which method is most suitable for your customisation needs. !!! Note - All callback methods described below should only be implemented in a strategy if they are actually used. + Callback methods should *only* be implemented if a strategy uses them. !!! Tip - You can get a strategy template containing all below methods by running `freqtrade new-strategy --strategy MyAwesomeStrategy --template advanced` + Start off with a strategy template containing all available callback methods by running `freqtrade new-strategy --strategy MyAwesomeStrategy --template advanced` ## Storing information