Skip to content

Improve CLI date argument help text documentation#59797

Merged
potiuk merged 1 commit intoapache:mainfrom
Arunodoy18:fix/improve-cli-date-argument-help-text
Dec 25, 2025
Merged

Improve CLI date argument help text documentation#59797
potiuk merged 1 commit intoapache:mainfrom
Arunodoy18:fix/improve-cli-date-argument-help-text

Conversation

@Arunodoy18
Copy link

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.

Fixes: Incomplete documentation of date format options

Improves the CLI help text documentation for --start-date and --end-date arguments to accurately reflect the supported datetime formats.

Problem

The help text for date arguments only documented YYYY-MM-DD format, but the actual implementation uses pendulum.parse() which accepts many more formats including ISO 8601, RFC 3339, and others.

Solution

Updated the help text to document commonly used formats and reference pendulum.parse() for complete format support.

Testing

Run airflow dags backfill --help to verify the updated help text displays correctly.

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.

Fixes: Incomplete documentation of date format options
@Arunodoy18

This comment was marked as spam.

@potiuk potiuk added this to the Airflow 3.1.6 milestone Dec 25, 2025
@potiuk potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Dec 25, 2025
@potiuk potiuk merged commit c3824f2 into apache:main Dec 25, 2025
70 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 25, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

github-actions bot pushed a commit that referenced this pull request Dec 25, 2025
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 c3824f2)

Co-authored-by: Arunodoy Banerjee <arunodoy630@gmail.com>
Fixes: Incomplete documentation of date format options
@github-actions
Copy link

Backport successfully created: v3-1-test

Status Branch Result
v3-1-test PR Link

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Dec 25, 2025
…#59797)

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 c3824f2)

Co-authored-by: Arunodoy Banerjee <arunodoy630@gmail.com>
Fixes: Incomplete documentation of date format options
potiuk pushed a commit that referenced this pull request Dec 26, 2025
#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 c3824f2)


Fixes: Incomplete documentation of date format options

Co-authored-by: Arunodoy Banerjee <arunodoy630@gmail.com>
amoghrajesh pushed a commit to astronomer/airflow that referenced this pull request Dec 29, 2025
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.

Fixes: Incomplete documentation of date format options
Subham-KRLX pushed a commit to Subham-KRLX/airflow that referenced this pull request Jan 2, 2026
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.

Fixes: Incomplete documentation of date format options
ephraimbuddy pushed a commit that referenced this pull request Jan 6, 2026
#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 c3824f2)


Fixes: Incomplete documentation of date format options

Co-authored-by: Arunodoy Banerjee <arunodoy630@gmail.com>
stegololz pushed a commit to stegololz/airflow that referenced this pull request Jan 9, 2026
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.

Fixes: Incomplete documentation of date format options
jhgoebbert pushed a commit to jhgoebbert/airflow_Owen-CH-Leung that referenced this pull request Feb 8, 2026
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.

Fixes: Incomplete documentation of date format options
Subham-KRLX pushed a commit to Subham-KRLX/airflow that referenced this pull request Mar 4, 2026
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.

Fixes: Incomplete documentation of date format options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:CLI backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants