XD-DENG commented on code in PR #27333: URL: https://github.com/apache/airflow/pull/27333#discussion_r1007808785
########## docs/apache-airflow/howto/operator/time.rst: ########## @@ -0,0 +1,78 @@ + .. 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:TimeDeltaSensor: + +TimeDeltaSensor +=============== + +Use the :class:`~airflow.sensors.time_delta.TimeDeltaSensor` to end sensing after specific time + + +.. exampleinclude:: /../../airflow/example_dags/example_sensors.py + :language: python + :dedent: 4 + :start-after: [START example_time_delta_sensor] + :end-before: [END example_time_delta_sensor] + + +.. _howto/operator:TimeDeltaSensorAsync: + +TimeDeltaSensorAsync +==================== + +Use the :class:`~airflow.sensors.time_delta.TimeDeltaSensorAsync` to end sensing after specific time. +It is an async version of the operator and requires Triggerer to run. + + +.. exampleinclude:: /../../airflow/example_dags/example_sensors.py + :language: python + :dedent: 4 + :start-after: [START example_time_delta_sensor_async] + :end-before: [END example_time_delta_sensor_async] + + + +.. _howto/operator:TimeSensor: + +TimeDeltaSensor Review Comment: ```suggestion TimeSensor ``` Is this a typo here? ########## docs/apache-airflow/howto/operator/time.rst: ########## @@ -0,0 +1,78 @@ + .. 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:TimeDeltaSensor: + +TimeDeltaSensor +=============== + +Use the :class:`~airflow.sensors.time_delta.TimeDeltaSensor` to end sensing after specific time Review Comment: ```suggestion Use the :class:`~airflow.sensors.time_delta.TimeDeltaSensor` to end sensing after specific time. ``` ########## docs/apache-airflow/howto/operator/time.rst: ########## @@ -0,0 +1,78 @@ + .. 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:TimeDeltaSensor: + +TimeDeltaSensor +=============== + +Use the :class:`~airflow.sensors.time_delta.TimeDeltaSensor` to end sensing after specific time + + +.. exampleinclude:: /../../airflow/example_dags/example_sensors.py + :language: python + :dedent: 4 + :start-after: [START example_time_delta_sensor] + :end-before: [END example_time_delta_sensor] + + +.. _howto/operator:TimeDeltaSensorAsync: + +TimeDeltaSensorAsync +==================== + +Use the :class:`~airflow.sensors.time_delta.TimeDeltaSensorAsync` to end sensing after specific time. +It is an async version of the operator and requires Triggerer to run. + + +.. exampleinclude:: /../../airflow/example_dags/example_sensors.py + :language: python + :dedent: 4 + :start-after: [START example_time_delta_sensor_async] + :end-before: [END example_time_delta_sensor_async] + + + +.. _howto/operator:TimeSensor: + +TimeDeltaSensor +=============== + +Use the :class:`~airflow.sensors.time_sensor.TimeSensor` to end sensing after time specified. + +.. exampleinclude:: /../../airflow/example_dags/example_sensors.py + :language: python + :dedent: 4 + :start-after: [START example_time_sensors] + :end-before: [END example_time_sensors] + + +.. _howto/operator:TimeSensorAsync: + +TimeDeltaSensorAsync Review Comment: ```suggestion TimeSensorAsync ``` Also seems a typo here? ########## airflow/sensors/time_delta.py: ########## @@ -28,6 +28,12 @@ class TimeDeltaSensor(BaseSensorOperator): Waits for a timedelta after the run's data interval. :param delta: time length to wait after the data interval before succeeding. + + .. seealso:: + For more information on how to use this sensor, take a look at the guide: Review Comment: Very minor thing: I see sometimes you wrote _"For more information on how to use this **sensor**"_ and sometimes you wrote _"For more information on how to use this **operator**"_. Does it make sense to you to make it more consistent? -- 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]
