You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by po...@apache.org on 2025/12/26 01:07:33 UTC

(airflow) branch v3-1-test updated: [v3-1-test] Improve CLI date argument help text documentation (#59797) (#59810)

This is an automated email from the ASF dual-hosted git repository.

potiuk pushed a commit to branch v3-1-test
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/v3-1-test by this push:
     new e9e74a484dc [v3-1-test] Improve CLI date argument help text documentation (#59797) (#59810)
e9e74a484dc is described below

commit e9e74a484dc1120403b3b6215fd8d0762631d2d1
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Fri Dec 26 02:07:26 2025 +0100

    [v3-1-test] Improve CLI date argument help text documentation (#59797) (#59810)
    
    The help text for --start-date and --end-date arguments only
    documented the YYYY-MM-DD format, but the actual implementation
    uses pendulum.parse() which accepts a much wider variety of formats.
    
    This commit updates the help text to accurately document the
    commonly used formats:
    - YYYY-MM-DD (date only)
    - YYYY-MM-DDTHH:MM:SS (datetime)
    - YYYY-MM-DDTHH:MM:SSHH:MM (datetime with timezone, ISO 8601)
    
    The help text also references pendulum.parse() to indicate that
    additional formats are supported, improving clarity for users.
    (cherry picked from commit c3824f27001994d67bf7c4ee31ada43119ebbff0)
    
    
    Fixes: Incomplete documentation of date format options
    
    Co-authored-by: Arunodoy Banerjee <ar...@gmail.com>
---
 airflow-core/src/airflow/cli/cli_config.py | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/airflow-core/src/airflow/cli/cli_config.py b/airflow-core/src/airflow/cli/cli_config.py
index a5062545e86..15ca7917857 100644
--- a/airflow-core/src/airflow/cli/cli_config.py
+++ b/airflow-core/src/airflow/cli/cli_config.py
@@ -167,8 +167,24 @@ ARG_BUNDLE_NAME = Arg(
     default=None,
     action="append",
 )
-ARG_START_DATE = Arg(("-s", "--start-date"), help="Override start_date YYYY-MM-DD", type=parsedate)
-ARG_END_DATE = Arg(("-e", "--end-date"), help="Override end_date YYYY-MM-DD", type=parsedate)
+ARG_START_DATE = Arg(
+    ("-s", "--start-date"),
+    help=(
+        "Override start_date. Accepts multiple datetime formats including: "
+        "YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DDTHH:MM:SS±HH:MM (ISO 8601), "
+        "and other formats supported by pendulum.parse()"
+    ),
+    type=parsedate,
+)
+ARG_END_DATE = Arg(
+    ("-e", "--end-date"),
+    help=(
+        "Override end_date. Accepts multiple datetime formats including: "
+        "YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, YYYY-MM-DDTHH:MM:SS±HH:MM (ISO 8601), "
+        "and other formats supported by pendulum.parse()"
+    ),
+    type=parsedate,
+)
 ARG_OUTPUT_PATH = Arg(
     (
         "-o",