feat: help message of market if not provided

QuantConnect · Jul 31, 2024 · d396d42 · d396d42
1 parent 7ad765a
commit d396d42
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -907,7 +907,8 @@ Options:
                                   Specify the resolution of the historical data
   --security-type [Equity|Index|Forex|Cfd|Future|Crypto|CryptoFuture|Option|IndexOption|Commodity|FutureOption]
                                   Specify the security type of the historical data
-  --market TEXT                   Specify the market name for tickers (e.g., 'USA', 'NYMEX', 'Binance')
+  --market TEXT                   Specify the market name for tickers (e.g., 'USA', 'NYMEX', 'Binance') (if not provided
+                                  or empty the default market for the requested security type will be used)
   --ticker TEXT                   Specify comma separated list of tickers to use for historical data request.
   --start TEXT                    Specify the start date for the historical data request in the format yyyyMMdd.
   --end TEXT                      Specify the end date for the historical data request in the format yyyyMMdd. (defaults

diff --git a/lean/commands/data/download.py b/lean/commands/data/download.py
@@ -536,7 +536,8 @@ def _replace_data_type(ctx, param, value):
 @option("--security-type", type=Choice(QCSecurityType.get_all_members(), case_sensitive=False),
     help="Specify the security type of the historical data")
 @option("--market", type=str,
-        help="Specify the market name for tickers (e.g., 'USA', 'NYMEX', 'Binance')")
+        help="Specify the market name for tickers (e.g., 'USA', 'NYMEX', 'Binance')"
+             " (if not provided or empty the default market for the requested security type will be used)")
 @option("--ticker",
         type=str,
         help="Specify comma separated list of tickers to use for historical data request.")