From 6934088a59a9197e5bb7b910aa4f4093372ba6fb Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 29 Apr 2024 07:12:19 +0200 Subject: [PATCH] Fix some non-working links --- docs/backtesting.md | 4 ++-- docs/configuration.md | 6 +++--- docs/exchanges.md | 2 +- docs/hyperopt.md | 2 +- docs/installation.md | 2 +- docs/leverage.md | 2 +- docs/stoploss.md | 2 +- docs/strategy-advanced.md | 2 +- docs/strategy-callbacks.md | 4 ++-- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/backtesting.md b/docs/backtesting.md index 17ae4022d..5fdfd6556 100644 --- a/docs/backtesting.md +++ b/docs/backtesting.md @@ -522,8 +522,8 @@ To save time, by default backtest will reuse a cached result from within the las ### Further backtest-result analysis -To further analyze your backtest results, you can [export the trades](#exporting-trades-to-file). -You can then load the trades to perform further analysis as shown in the [data analysis](data-analysis.md#backtesting) backtesting section. +To further analyze your backtest results, freqtrade will export the trades to file by default. +You can then load the trades to perform further analysis as shown in the [data analysis](strategy_analysis_example.md#load-backtest-results-to-pandas-dataframe) backtesting section. ## Assumptions made by backtesting diff --git a/docs/configuration.md b/docs/configuration.md index 6a85f445e..6e89348e4 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -197,7 +197,7 @@ Mandatory parameters are marked as **Required**, which means that they are requi | `position_adjustment_enable` | Enables the strategy to use position adjustments (additional buys or sells). [More information here](strategy-callbacks.md#adjust-trade-position).
[Strategy Override](#parameters-in-the-strategy).
*Defaults to `false`.*
**Datatype:** Boolean | `max_entry_position_adjustment` | Maximum additional order(s) for each open trade on top of the first entry Order. Set it to `-1` for unlimited additional orders. [More information here](strategy-callbacks.md#adjust-trade-position).
[Strategy Override](#parameters-in-the-strategy).
*Defaults to `-1`.*
**Datatype:** Positive Integer or -1 | | **Exchange** -| `exchange.name` | **Required.** Name of the exchange class to use. [List below](#user-content-what-values-for-exchangename).
**Datatype:** String +| `exchange.name` | **Required.** Name of the exchange class to use.
**Datatype:** String | `exchange.key` | API key to use for the exchange. Only required when you are in production mode.
**Keep it in secret, do not disclose publicly.**
**Datatype:** String | `exchange.secret` | API secret to use for the exchange. Only required when you are in production mode.
**Keep it in secret, do not disclose publicly.**
**Datatype:** String | `exchange.password` | API password to use for the exchange. Only required when you are in production mode and for exchanges that use password for API requests.
**Keep it in secret, do not disclose publicly.**
**Datatype:** String @@ -252,7 +252,7 @@ Mandatory parameters are marked as **Required**, which means that they are requi | `disable_dataframe_checks` | Disable checking the OHLCV dataframe returned from the strategy methods for correctness. Only use when intentionally changing the dataframe and understand what you are doing. [Strategy Override](#parameters-in-the-strategy).
*Defaults to `False`*.
**Datatype:** Boolean | `internals.process_throttle_secs` | Set the process throttle, or minimum loop duration for one bot iteration loop. Value in second.
*Defaults to `5` seconds.*
**Datatype:** Positive Integer | `internals.heartbeat_interval` | Print heartbeat message every N seconds. Set to 0 to disable heartbeat messages.
*Defaults to `60` seconds.*
**Datatype:** Positive Integer or 0 -| `internals.sd_notify` | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](installation.md#7-optional-configure-freqtrade-as-a-systemd-service) for more details.
**Datatype:** Boolean +| `internals.sd_notify` | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](advanced-setup.md#configure-the-bot-running-as-a-systemd-service) for more details.
**Datatype:** Boolean | `strategy` | **Required** Defines Strategy class to use. Recommended to be set via `--strategy NAME`.
**Datatype:** ClassName | `strategy_path` | Adds an additional strategy lookup path (must be a directory).
**Datatype:** String | `recursive_strategy_search` | Set to `true` to recursively search sub-directories inside `user_data/strategies` for a strategy.
**Datatype:** Boolean @@ -370,7 +370,7 @@ This setting works in combination with `max_open_trades`. The maximum capital en For example, the bot will at most use (0.05 BTC x 3) = 0.15 BTC, assuming a configuration of `max_open_trades=3` and `stake_amount=0.05`. !!! Note - This setting respects the [available balance configuration](#available-balance). + This setting respects the [available balance configuration](#tradable-balance). #### Dynamic stake amount diff --git a/docs/exchanges.md b/docs/exchanges.md index a8c4a8b4f..d4437cfff 100644 --- a/docs/exchanges.md +++ b/docs/exchanges.md @@ -299,7 +299,7 @@ $ pip3 install web3 Most exchanges return current incomplete candle via their OHLCV/klines API interface. By default, Freqtrade assumes that incomplete candle is fetched from the exchange and removes the last candle assuming it's the incomplete candle. -Whether your exchange returns incomplete candles or not can be checked using [the helper script](developer.md#Incomplete-candles) from the Contributor documentation. +Whether your exchange returns incomplete candles or not can be checked using [the helper script](developer.md#incomplete-candles) from the Contributor documentation. Due to the danger of repainting, Freqtrade does not allow you to use this incomplete candle. diff --git a/docs/hyperopt.md b/docs/hyperopt.md index 524ce5c88..f88928344 100644 --- a/docs/hyperopt.md +++ b/docs/hyperopt.md @@ -806,7 +806,7 @@ If you have the `stoploss_space()` method in your custom hyperopt file, remove i Override the `stoploss_space()` method and define the desired range in it if you need stoploss values to vary in other range during hyperoptimization. A sample for this method can be found in the [overriding pre-defined spaces section](advanced-hyperopt.md#overriding-pre-defined-spaces). !!! Note "Reduced search space" - To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however [overriding pre-defined spaces](advanced-hyperopt.md#pverriding-pre-defined-spaces) to change this to your needs. + To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however [overriding pre-defined spaces](advanced-hyperopt.md#overriding-pre-defined-spaces) to change this to your needs. ### Understand Hyperopt Trailing Stop results diff --git a/docs/installation.md b/docs/installation.md index a87a3ff4e..189f45cfa 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -51,7 +51,7 @@ These requirements apply to both [Script Installation](#script-installation) and ### Install code We've included/collected install instructions for Ubuntu, MacOS, and Windows. These are guidelines and your success may vary with other distros. -OS Specific steps are listed first, the [Common](#common) section below is necessary for all systems. +OS Specific steps are listed first, the common section below is necessary for all systems. !!! Note Python3.9 or higher and the corresponding pip are assumed to be available. diff --git a/docs/leverage.md b/docs/leverage.md index 09ebf1075..2fbd13145 100644 --- a/docs/leverage.md +++ b/docs/leverage.md @@ -17,7 +17,7 @@ If you already have an existing strategy, please read the [strategy migration gu ## Shorting -Shorting is not possible when trading with [`trading_mode`](#understand-tradingmode) set to `spot`. To short trade, `trading_mode` must be set to `margin`(currently unavailable) or [`futures`](#futures), with [`margin_mode`](#margin-mode) set to `cross`(currently unavailable) or [`isolated`](#isolated-margin-mode) +Shorting is not possible when trading with [`trading_mode`](#leverage-trading-modes) set to `spot`. To short trade, `trading_mode` must be set to `margin`(currently unavailable) or [`futures`](#futures), with [`margin_mode`](#margin-mode) set to `cross`(currently unavailable) or [`isolated`](#isolated-margin-mode) For a strategy to short, the strategy class must set the class variable `can_short = True` diff --git a/docs/stoploss.md b/docs/stoploss.md index 19683aadd..a1095b465 100644 --- a/docs/stoploss.md +++ b/docs/stoploss.md @@ -158,7 +158,7 @@ You could also have a default stop loss when you are in the red with your buy (b For example, your default stop loss is -10%, but once you have more than 0% profit (example 0.1%) a different trailing stoploss will be used. !!! Note - If you want the stoploss to only be changed when you break even of making a profit (what most users want) please refer to next section with [offset enabled](#Trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset). + If you want the stoploss to only be changed when you break even of making a profit (what most users want) please refer to next section with [offset enabled](#trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset). Both values require `trailing_stop` to be set to true and `trailing_stop_positive` with a value. diff --git a/docs/strategy-advanced.md b/docs/strategy-advanced.md index c5a17c364..3cd0259f4 100644 --- a/docs/strategy-advanced.md +++ b/docs/strategy-advanced.md @@ -209,7 +209,7 @@ def custom_exit(self, pair: str, trade: Trade, current_time: datetime, current_r ## Exit tag -Similar to [Buy Tagging](#buy-tag), you can also specify a sell tag. +Similar to [Entry Tagging](#enter-tag), you can also specify an exit tag. ``` python def populate_exit_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame: diff --git a/docs/strategy-callbacks.md b/docs/strategy-callbacks.md index e39a4f102..b1e46d356 100644 --- a/docs/strategy-callbacks.md +++ b/docs/strategy-callbacks.md @@ -167,7 +167,7 @@ During backtesting, `current_rate` (and `current_profit`) are provided against t The absolute value of the return value is used (the sign is ignored), so returning `0.05` or `-0.05` have the same result, a stoploss 5% below the current price. Returning None will be interpreted as "no desire to change", and is the only safe way to return when you'd like to not modify the stoploss. -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-exchange-freqtrade)). +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)). !!! Note "Use of dates" 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. @@ -450,7 +450,7 @@ Stoploss values returned from `custom_stoploss()` must specify a percentage rela ``` - Full examples can be found in the [Custom stoploss](strategy-advanced.md#custom-stoploss) section of the Documentation. + Full examples can be found in the [Custom stoploss](strategy-callbacks.md#custom-stoploss) section of the Documentation. !!! Note Providing invalid input to `stoploss_from_open()` may produce "CustomStoploss function did not return valid stoploss" warnings.