Improving the docs

apache · Aug 14, 2015 · 966d7f0 · 966d7f0
1 parent 0b72369
commit 966d7f0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/airflow/models.py b/airflow/models.py
@@ -1535,7 +1535,11 @@ class DAG(object):
         Note that jinja/airflow includes the path of your DAG file by
         default
     :type template_searchpath: string or list of stings
-    :param user_defined_macros: a dictionary of macros that will be merged
+    :param user_defined_macros: a dictionary of macros that will be exposed
+        in your jinja templates. For example, passing ``dict(foo='bar')``
+        to this argument allows you to ``{{ foo }}`` in all jinja
+        templates related to this DAG. Note that you can pass any
+        type of object here.
     :type user_defined_macros: dict
     :param default_args: A dictionary of default parameters to be used
         as constructor keyword parameters when initialising operators.

diff --git a/airflow/operators/hive_operator.py b/airflow/operators/hive_operator.py
@@ -15,7 +15,10 @@ class HiveOperator(BaseOperator):
     :param hive_cli_conn_id: reference to the Hive database
     :type hive_cli_conn_id: string
     :param hiveconf_jinja_translate: when True, hiveconf-type templating
-        ${var} gets translated into jina-type templating {{ var }}
+        ${var} gets translated into jina-type templating {{ var }}. Note that
+        you may want to use along this along with the
+        ``DAG(user_defined_macros=myargs)`` parameter. View the DAG
+        object documentation for more details.
     :type hiveconf_jinja_translate: boolean
     :param script_begin_tag: If defined, the operator will get rid of the
         part of the script before the first occurrence of `script_begin_tag`