adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Apply suggested documentation changes from code review

Browse Source 
Co-authored-by: hroff-1902 <47309513+hroff-1902@users.noreply.github.com>
This commit is contained in:
Matthias 2020-07-04 09:43:49 +02:00 committed by GitHub
parent c2a6f70b4c
commit c4a9a79be0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/bot-basics.md
View File

@ -1,10 +1,10 @@
# Freqtrade basics # Freqtrade basics
This page will try to teach you some basic concepts on how freqtrade works and operates. This page provides you some basic concepts on how Freqtrade works and operates.
## Freqtrade terminology ## Freqtrade terminology
* Trade: Open position * Trade: Open position.
* Open Order: Order which is currently placed on the exchange, and is not yet complete. * Open Order: Order which is currently placed on the exchange, and is not yet complete.
* Pair: Tradable pair, usually in the format of Quote/Base (e.g. XRP/USDT). * Pair: Tradable pair, usually in the format of Quote/Base (e.g. XRP/USDT).
* Timeframe: Candle length to use (e.g. `"5m"`, `"1h"`, ...). * Timeframe: Candle length to use (e.g. `"5m"`, `"1h"`, ...).

12
docs/strategy-advanced.md
View File

@ -3,7 +3,7 @@
This page explains some advanced concepts available for 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 be familiar with the methods described in the [Strategy Customization](strategy-customization.md) documentation and with the [Freqtrade basics](bot-basics.md) first.
[Freqtrade basics](bot-basics.md) describes in which sequence each method defined below is called, which can be helpful to understand which method to use. [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.
!!! Note !!! Note
All callback methods described below should only be implemented in a strategy if they are also actively used. All callback methods described below should only be implemented in a strategy if they are also actively used.
@ -97,8 +97,8 @@ class Awesomestrategy(IStrategy):
## Bot loop start callback ## Bot loop start callback
A simple callback which is called at the start of every bot iteration. A simple callback which is called once at the start of every bot throttling iteration.
This can be used to perform calculations which are pair independent. This can be used to perform calculations which are pair independent (apply to all pairs), loading of external data, etc.
``` python ``` python
import requests import requests
@ -111,7 +111,7 @@ class Awesomestrategy(IStrategy):
""" """
Called at the start of the bot iteration (one loop). Called at the start of the bot iteration (one loop).
Might be used to perform pair-independent tasks Might be used to perform pair-independent tasks
(e.g. gather some remote ressource for comparison) (e.g. gather some remote resource for comparison)
:param **kwargs: Ensure to keep this here so updates to this won't break your strategy. :param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
""" """
if self.config['runmode'].value in ('live', 'dry_run'): if self.config['runmode'].value in ('live', 'dry_run'):
@ -125,7 +125,7 @@ class Awesomestrategy(IStrategy):
### Trade entry (buy order) confirmation ### Trade entry (buy order) confirmation
`confirm_trade_entry()` an be used to abort a trade entry at the latest second (maybe because the price is not what we expect). `confirm_trade_entry()` can be used to abort a trade entry at the latest second (maybe because the price is not what we expect).
``` python ``` python
class Awesomestrategy(IStrategy): class Awesomestrategy(IStrategy):
@ -158,7 +158,7 @@ class Awesomestrategy(IStrategy):
### Trade exit (sell order) confirmation ### Trade exit (sell order) confirmation
`confirm_trade_exit()` an be used to abort a trade exit (sell) at the latest second (maybe because the price is not what we expect). `confirm_trade_exit()` can be used to abort a trade exit (sell) at the latest second (maybe because the price is not what we expect).
``` python ``` python
from freqtrade.persistence import Trade from freqtrade.persistence import Trade

4
docs/strategy-customization.md
View File

@ -1,8 +1,8 @@
# Strategy Customization # Strategy Customization
This page explains how to customize your strategies, and add new indicators. This page explains how to customize your strategies, add new indicators and set up trading rules.
Please familiarize yourself with [Freqtrade basics](bot-basics.md) first. Please familiarize yourself with [Freqtrade basics](bot-basics.md) first, which provides overall info on how the bot operates.
## Install a custom strategy file ## Install a custom strategy file

2
freqtrade/strategy/interface.py
View File

@ -194,7 +194,7 @@ class IStrategy(ABC):
""" """
Called at the start of the bot iteration (one loop). Called at the start of the bot iteration (one loop).
Might be used to perform pair-independent tasks Might be used to perform pair-independent tasks
(e.g. gather some remote ressource for comparison) (e.g. gather some remote resource for comparison)
:param **kwargs: Ensure to keep this here so updates to this won't break your strategy. :param **kwargs: Ensure to keep this here so updates to this won't break your strategy.
""" """
pass pass