From 7a11219b613b2ce782afa113456e2571a54817cc Mon Sep 17 00:00:00 2001 From: Matthias Date: Sat, 16 May 2020 13:17:48 +0200 Subject: [PATCH] Reword some documentation strings Co-authored-by: hroff-1902 <47309513+hroff-1902@users.noreply.github.com> --- docs/configuration.md | 2 +- freqtrade/commands/cli_options.py | 2 +- freqtrade/freqtradebot.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index b0b840fcc..7405fc92e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -51,7 +51,7 @@ Mandatory parameters are marked as **Required**, which means that they are requi | `fiat_display_currency` | Fiat currency used to show your profits. [More information below](#what-values-can-be-used-for-fiat_display_currency).
**Datatype:** String | `dry_run` | **Required.** Define if the bot must be in Dry Run or production mode.
*Defaults to `true`.*
**Datatype:** Boolean | `dry_run_wallet` | Define the starting amount in stake currency for the simulated wallet used by the bot running in the Dry Run mode.
*Defaults to `1000`.*
**Datatype:** Float -| `cancel_open_orders_on_exit` | Cancel orders when `/stop` is issued or `ctrl+c` is pressed. This will allow you to use `/stop` to cancel unfilled orders in the event of a market crash. This will not impact open positions.
*Defaults to `False`.*
**Datatype:** Boolean +| `cancel_open_orders_on_exit` | Cancel open orders when the `/stop` RPC command is issued, `Ctrl+C` is pressed or the bot dies unexpectedly. When set to `true`, this allows you to use `/stop` to cancel unfilled and partially filled orders in the event of a market crash. It does not impact open positions.
*Defaults to `false`.*
**Datatype:** Boolean | `process_only_new_candles` | Enable processing of indicators only when new candles arrive. If false each loop populates the indicators, this will mean the same candle is processed many times creating system load but can be useful of your strategy depends on tick data not only candle. [Strategy Override](#parameters-in-the-strategy).
*Defaults to `false`.*
**Datatype:** Boolean | `minimal_roi` | **Required.** Set the threshold in percent the bot will use to sell a trade. [More information below](#understand-minimal_roi). [Strategy Override](#parameters-in-the-strategy).
**Datatype:** Dict | `stoploss` | **Required.** Value of the stoploss in percent used by the bot. More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).
**Datatype:** Float (as ratio) diff --git a/freqtrade/commands/cli_options.py b/freqtrade/commands/cli_options.py index cca9d7048..7a2110a91 100644 --- a/freqtrade/commands/cli_options.py +++ b/freqtrade/commands/cli_options.py @@ -111,7 +111,7 @@ AVAILABLE_CLI_OPTIONS = { ), "cancel_open_orders_on_exit": Arg( '--cancel-open-orders-on-exit', - help='Close unfilled open orders when the bot stops / exits', + help='Close unfilled and partially filled open orders when the bot stops / exits.', action='store_true', ), # Optimize common diff --git a/freqtrade/freqtradebot.py b/freqtrade/freqtradebot.py index cad8b4aea..3b3758f36 100644 --- a/freqtrade/freqtradebot.py +++ b/freqtrade/freqtradebot.py @@ -170,7 +170,7 @@ class FreqtradeBot: def process_stopped(self) -> None: """ - Close all trades that were left open + Close all orders that were left open """ if self.config['cancel_open_orders_on_exit']: self.cancel_all_open_orders()