eladkal commented on code in PR #74225: URL: https://github.com/apache/airflow/pull/74225#discussion_r4218436051
########## providers/databricks/docs/operators/delta_table_sensor.rst: ########## Review Comment: I am not very happy with this doc. Feels very AI generated and not designed to be read by humans. It feels as if the doc explains the code. parameter by parameter. There are too many bold statements and too many things marked as important. ########## providers/databricks/docs/operators/delta_table_sensor.rst: ########## @@ -0,0 +1,141 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. _howto/operator:DatabricksDeltaTableVersionSensor: + +DatabricksDeltaTableVersionSensor (Phase 1) +=========================================== + +Use the :class:`~airflow.providers.databricks.sensors.databricks_delta_table.DatabricksDeltaTableVersionSensor` +to monitor a Delta table in Databricks and detect new commit versions. When a newer version is observed, +the sensor succeeds, pushes provenance metadata to XCom, and optionally emits an Airflow Asset event. + +The sensor can execute synchronously in standard worker slots or in deferrable mode using +:class:`~airflow.providers.databricks.triggers.databricks_delta_table.DatabricksDeltaTableVersionTrigger`. + +.. note:: + + **Scope (Phase 1 only):** This sensor provides task-level Delta table version observation inside a scheduled + DAG task run. A continuous external asset producer with long-running coalescing across runs is planned as a + follow-up Phase 2 feature. Review Comment: This is use facing doc. Users don't care about phases. We should just document what we currently have. If explaining about future work has value then it's OK to mention it but then please explain why it's important to highlight? every feature of airflow can be enhanced further that is how software works :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
