You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ep...@apache.org on 2023/10/05 10:45:55 UTC

[airflow] 08/44: Schedule default value description (#34291)

This is an automated email from the ASF dual-hosted git repository.

ephraimanierobi pushed a commit to branch v2-7-test
in repository https://gitbox.apache.org/repos/asf/airflow.git

commit 4fcdeaac63136c1815c8289a7f9aeed5033c87b6
Author: Rafael Carrasco <ra...@gmail.com>
AuthorDate: Sat Sep 16 12:08:55 2023 -0500

    Schedule default value description (#34291)
    
    * added clarification around schedule parameter
    
    * rewriting explanation of default value
    
    * Update airflow/models/dag.py
    
    Co-authored-by: Tzu-ping Chung <ur...@gmail.com>
    
    * Update dag.py
    
    * Fix trailing whitespace
    
    ---------
    
    Co-authored-by: Tzu-ping Chung <ur...@gmail.com>
    (cherry picked from commit 5ab7517258716445ac583c41656fdb17f87f57a8)
---
 airflow/models/dag.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/airflow/models/dag.py b/airflow/models/dag.py
index d8c8628770..ca3cce4cc4 100644
--- a/airflow/models/dag.py
+++ b/airflow/models/dag.py
@@ -305,7 +305,8 @@ class DAG(LoggingMixin):
     :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`.
+        If this is not provided, the DAG will be set to the default
+        schedule ``timedelta(days=1)``. See also :doc:`/howto/timetable`.
     :param start_date: The timestamp from which the scheduler will
         attempt to backfill
     :param end_date: A date beyond which your DAG won't run, leave to None