uranusjr commented on code in PR #23662: URL: https://github.com/apache/airflow/pull/23662#discussion_r932852194
########## docs/apache-airflow/concepts/timetable.rst: ########## @@ -55,15 +55,25 @@ Built In Timetables Airflow comes with several common timetables built in to cover the most common use cases. Additional timetables may be available in plugins. -CronDataIntervalTimetable +CronTriggerTimetable ^^^^^^^^^^^^^^^^^^^^^^^^^ -Set schedule based on a cron expression. Can be selected by providing a string that is a valid -cron expression to the ``schedule_interval`` parameter of a DAG as described in the :doc:`/concepts/dags` documentation. +Another timetable which accepts a cron expression. It behaves more compliant with standard cron than ``CronDataIntervalTimetable``. + +The main difference from ``CronDataIntervalTimetable`` is that a first DAG Run is kicked off at the start of the period like +a normal cron, while a first DAG Run of ``CronDataIntervalTimetable`` starts immediately after the DAG is registered. + +Note that this timetable does not care the idea of *data interval*. It means the value of ``data_interval_start``, +``data_interval_end`` and legacy ``execution_date`` are the same - the time when a DAG run is triggered. .. code-block:: python - @dag(schedule_interval="0 1 * * 3") # At 01:00 on Wednesday. + from airflow.timetables.interval import CronTriggerTimetable Review Comment: This import is not necessary ########## docs/apache-airflow/concepts/timetable.rst: ########## @@ -55,15 +55,25 @@ Built In Timetables Airflow comes with several common timetables built in to cover the most common use cases. Additional timetables may be available in plugins. -CronDataIntervalTimetable +CronTriggerTimetable ^^^^^^^^^^^^^^^^^^^^^^^^^ -Set schedule based on a cron expression. Can be selected by providing a string that is a valid -cron expression to the ``schedule_interval`` parameter of a DAG as described in the :doc:`/concepts/dags` documentation. +Another timetable which accepts a cron expression. It behaves more compliant with standard cron than ``CronDataIntervalTimetable``. + +The main difference from ``CronDataIntervalTimetable`` is that a first DAG Run is kicked off at the start of the period like +a normal cron, while a first DAG Run of ``CronDataIntervalTimetable`` starts immediately after the DAG is registered. + +Note that this timetable does not care the idea of *data interval*. It means the value of ``data_interval_start``, +``data_interval_end`` and legacy ``execution_date`` are the same - the time when a DAG run is triggered. Review Comment: We should also add a couple of paragraphs under ``CronDataIntervalTimetable`` to describe the same thing. It is probably a good idea to add hyperhink on CronDataIntervalTimetable here (and CronTriggerTimetable in the other section) so the user can easily jump between these sections. (See Sphinx documentation on how you can use `:ref:` to achieve this.) -- 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]
