From 265a798f780e8bb8623dd47a887a0321611e7155 Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Tue, 11 Mar 2025 06:37:44 +0100
Subject: [PATCH] docs: auto-generate command snippets

---
 docs/commands/backtesting-show.md | 7 ++++---
 docs/commands/backtesting.md      | 7 ++++---
 docs/commands/hyperopt-show.md    | 7 ++++---
 3 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/docs/commands/backtesting-show.md b/docs/commands/backtesting-show.md
index 1c7889851..a1b146a82 100644
--- a/docs/commands/backtesting-show.md
+++ b/docs/commands/backtesting-show.md
@@ -2,7 +2,7 @@
 usage: freqtrade backtesting-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
                                   [-c PATH] [-d PATH] [--userdir PATH]
                                   [--export-filename PATH] [--show-pair-list]
-                                  [--breakdown {day,week,month} [{day,week,month} ...]]
+                                  [--breakdown {day,week,month,year} [{day,week,month,year} ...]]
 
 options:
   -h, --help            show this help message and exit
@@ -11,8 +11,9 @@ options:
                         `--export` to be set as well. Example: `--export-filen
                         ame=user_data/backtest_results/backtest_today.json`
   --show-pair-list      Show backtesting pairlist sorted by profit.
-  --breakdown {day,week,month} [{day,week,month} ...]
-                        Show backtesting breakdown per [day, week, month].
+  --breakdown {day,week,month,year} [{day,week,month,year} ...]
+                        Show backtesting breakdown per [day, week, month,
+                        year].
 
 Common arguments:
   -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
diff --git a/docs/commands/backtesting.md b/docs/commands/backtesting.md
index 160bda7cc..395ab4b00 100644
--- a/docs/commands/backtesting.md
+++ b/docs/commands/backtesting.md
@@ -15,7 +15,7 @@ usage: freqtrade backtesting [-h] [-v] [--no-color] [--logfile FILE] [-V]
                              [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
                              [--export {none,trades,signals}]
                              [--export-filename PATH]
-                             [--breakdown {day,week,month} [{day,week,month} ...]]
+                             [--breakdown {day,week,month,year} [{day,week,month,year} ...]]
                              [--cache {none,day,week,month}]
                              [--freqai-backtest-live-models]
 
@@ -65,8 +65,9 @@ options:
                         Use this filename for backtest results.Requires
                         `--export` to be set as well. Example: `--export-filen
                         ame=user_data/backtest_results/backtest_today.json`
-  --breakdown {day,week,month} [{day,week,month} ...]
-                        Show backtesting breakdown per [day, week, month].
+  --breakdown {day,week,month,year} [{day,week,month,year} ...]
+                        Show backtesting breakdown per [day, week, month,
+                        year].
   --cache {none,day,week,month}
                         Load a cached backtest result no older than specified
                         age (default: day).
diff --git a/docs/commands/hyperopt-show.md b/docs/commands/hyperopt-show.md
index 9c7c378ab..14d6516e9 100644
--- a/docs/commands/hyperopt-show.md
+++ b/docs/commands/hyperopt-show.md
@@ -4,7 +4,7 @@ usage: freqtrade hyperopt-show [-h] [-v] [--no-color] [--logfile FILE] [-V]
                                [--profitable] [-n INT] [--print-json]
                                [--hyperopt-filename FILENAME] [--no-header]
                                [--disable-param-export]
-                               [--breakdown {day,week,month} [{day,week,month} ...]]
+                               [--breakdown {day,week,month,year} [{day,week,month,year} ...]]
 
 options:
   -h, --help            show this help message and exit
@@ -18,8 +18,9 @@ options:
   --no-header           Do not print epoch details header.
   --disable-param-export
                         Disable automatic hyperopt parameter export.
-  --breakdown {day,week,month} [{day,week,month} ...]
-                        Show backtesting breakdown per [day, week, month].
+  --breakdown {day,week,month,year} [{day,week,month,year} ...]
+                        Show backtesting breakdown per [day, week, month,
+                        year].
 
 Common arguments:
   -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).