Merge pull request #220 from bcgov/chore/218-refactor-dags

chore/218 refactor dags

Author: joshgamache

dags/fetch_and_save_dag_from_github.py

@@ -10,25 +10,26 @@
 
 START_DATE = datetime.now() - timedelta(days=2)
 
-
-@dag(default_args=default_dag_args, schedule=None, start_date=START_DATE)
-def fetch_and_save_dag_from_github(org: str = '', repo: str = '', ref: str = '', path: str = ''):
-    """
-      DAG to fetch dags and store them to a disk location.
-
-      :param org: Github organisation
-      :type org: str
-
-      :param repo: Github repository
-      :type repo: str
-
-      :param ref: the git ref to use when fetching the dag
-      :type ref: str
-
-      :param path: the path to the dag to fetch, within the github repository
-      :type path: str
-    """
-
+DAG_DOC = """
+DAG to fetch dags and store them to a disk location.
+
+The following parameters are available:
+
+**org**(_str_): Github organization
+**repo**(_str_): Github repository
+**ref**(_str_): the git ref to use when fetching the dag
+**path**(_str_): the path to the dag to fetch, within the github repository
+"""
+
+@dag(
+    default_args=default_dag_args,
+    schedule=None,
+    start_date=START_DATE,
+    doc_md=DAG_DOC,
+)
+def fetch_and_save_dag_from_github(
+    org: str = "", repo: str = "", ref: str = "", path: str = ""
+):
     wait_seconds = settings.MIN_SERIALIZED_DAG_FETCH_INTERVAL + \
         settings.MIN_SERIALIZED_DAG_UPDATE_INTERVAL