uranusjr commented on code in PR #25410:
URL: https://github.com/apache/airflow/pull/25410#discussion_r941987776
##########
airflow/models/dag.py:
##########
@@ -236,11 +237,16 @@ class DAG(LoggingMixin):
:param dag_id: The id of the DAG; must consist exclusively of alphanumeric
characters, dashes, dots and underscores (all ASCII)
:param description: The description for the DAG to e.g. be shown on the
webserver
+ :param schedule: Defines the rules according to which DAG runs are
scheduled. Can
+ accept cron string, timedelta object, Timetable, or list of Dataset
objects.
+ See also :doc:`/howto/timetable`.
:param schedule_interval: Defines how often that DAG runs, this
timedelta object gets added to your latest task instance's
- execution_date to figure out the next schedule
+ execution_date to figure out the next schedule.
+ Note: deprecated in Airflow 2.4; use `schedule` instead.
:param timetable: Specify which timetable to use (in which case
schedule_interval
must not be set). See :doc:`/howto/timetable` for more information
+ Note: deprecated in Airflow 2.4; use `schedule` instead.
Review Comment:
One approach used elsewhere is to document the existence of deprecated
arguments in the new replacement (i.e. `schedule`) and say something like _hey
if you see `schedule_interval` or `timetable` they are deprecated forms and
synonym of this_. This is slightly more difficult here since `DAG` has so many
arguments, but would probably still be good enough.
--
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]
