Skip to content

Fix broken class xrefs in standard provider docs - #73360

Merged
kaxil merged 1 commit into
apache:mainfrom
astronomer:worktree-fix-standard-sensor-docs-xref
Sep 19, 2026
Merged

kaxil merged 1 commit into
apache:mainfrom
astronomer:worktree-fix-standard-sensor-docs-xref

Conversation

@kaxil

@kaxil kaxil commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

DayOfWeekSensor's xref in the standard provider's sensor guide pointed at the pre-provider-split airflow.sensors.weekday path, which no longer exists; the class now lives under airflow.providers.standard.sensors.weekday.

BaseXCom's xref in the common.io XCom backend guide pointed at airflow.models.xcom.BaseXCom, a deprecated compat shim. The task-sdk docs only expose it at the flat airflow.sdk.BaseXCom path, matching the existing convention for this class of xref (e.g. airflow.sdk.ResumableJobMixin).

The TimeSensor xref in the same sensor guide is also broken (points at a non-existent sensors.time_sensor module) but is left alone here since #69610, #69746, and #69925 are all open against that same paragraph.

@kaxil
kaxil force-pushed the worktree-fix-standard-sensor-docs-xref branch from 17297cf to fe17d4c Compare September 18, 2026 21:38
@kaxil
kaxil requested a review from bolkedebruin as a code owner September 18, 2026 21:38
@kaxil kaxil changed the title Fix broken class xrefs in standard provider sensor docs Fix broken class xrefs in standard provider docs Sep 18, 2026
DayOfWeekSensor's xref in the standard provider's sensor guide pointed at
the pre-provider-split airflow.sensors.weekday path, which no longer
exists; the class now lives under airflow.providers.standard.sensors.weekday.

BaseXCom's xref in the common.io XCom backend guide pointed at
airflow.models.xcom.BaseXCom, a deprecated compat shim. The task-sdk docs
only expose it at the flat airflow.sdk.BaseXCom path (autoapiclass in
task-sdk/docs/api.rst, autoapi_generate_api_docs=False elsewhere), matching
the existing convention for this class of xref (e.g. airflow.sdk.ResumableJobMixin).

The TimeSensor xref in the same sensor guide is also broken (points at a
non-existent sensors.time_sensor module) but is left alone here since apache#69610,
apache#69746, and apache#69925 are all open against that same paragraph.
@kaxil
kaxil force-pushed the worktree-fix-standard-sensor-docs-xref branch from fe17d4c to 602270d Compare September 18, 2026 21:43
@kaxil
kaxil merged commit dd9ad59 into apache:main Sep 19, 2026
89 checks passed
@kaxil
kaxil deleted the worktree-fix-standard-sensor-docs-xref branch September 19, 2026 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants