[airflow] branch main updated: Add documentation to dag test function (#26713)

[ur...@apache.org]

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

uranusjr pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 9644b05d68 Add documentation to dag test function (#26713)
9644b05d68 is described below

commit 9644b05d683abaa45f9b0f8b3c1b05a2263b8523
Author: Daniel Imberman <da...@gmail.com>
AuthorDate: Tue Sep 27 20:54:25 2022 -0700

    Add documentation to dag test function (#26713)
    
    Co-authored-by: Kaxil Naik <ka...@gmail.com>
    Co-authored-by: Daniel Imberman <da...@Daniels-MBP.lan>
    Co-authored-by: Tzu-ping Chung <ur...@gmail.com>
---
 airflow/models/dag.py | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/airflow/models/dag.py b/airflow/models/dag.py
index 2371f44583..2583a2490e 100644
--- a/airflow/models/dag.py
+++ b/airflow/models/dag.py
@@ -2446,7 +2446,15 @@ class DAG(LoggingMixin):
         variable_file_path: str | None = None,
         session: Session = NEW_SESSION,
     ) -> None:
-        """Execute one single DagRun for a given DAG and execution date."""
+        """
+        Execute one single DagRun for a given DAG and execution date.
+
+        :param execution_date: execution date for the DAG run
+        :param run_conf: configuration to pass to newly created dagrun
+        :param conn_file_path: file path to a connection file in either yaml or json
+        :param variable_file_path: file path to a variable file in either yaml or json
+        :param session: database connection (optional)
+        """
 
         def add_logger_if_needed(ti: TaskInstance):
             """