You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "roc chan (JIRA)" <ji...@apache.org> on 2018/05/20 09:24:00 UTC

[jira] [Work started] (AIRFLOW-2493) Mark template_fields of all Operators in the API document as "templated"

     [ https://issues.apache.org/jira/browse/AIRFLOW-2493?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Work on AIRFLOW-2493 started by roc chan.
-----------------------------------------
> Mark template_fields of all Operators in the API document as "templated"
> ------------------------------------------------------------------------
>
>                 Key: AIRFLOW-2493
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2493
>             Project: Apache Airflow
>          Issue Type: Improvement
>    Affects Versions: 2.0.0, 1.10
>            Reporter: roc chan
>            Assignee: roc chan
>            Priority: Minor
>
> I saw some words from Concepts-Additional Functionality-Jinjia Templating in the document : [http://airflow.readthedocs.io/en/latest/concepts.html?highlight=xcom#jinja-templating] 
> *You can use Jinja templating with every parameter that is marked as “templated” in the documentation. Template substitution occurs just before the pre_execute function of your operator is called.*
> But the actual situation of the API document is not like this,only a small portion of template_fields have marked "(templated)", for example, *BashOperator*'s *env* has been marked, but *bash_command* is not ([http://airflow.readthedocs.io/en/latest/code.html#airflow.operators.bash_operator.BashOperator)|http://airflow.readthedocs.io/en/latest/code.html#airflow.operators.bash_operator.BashOperator)*,*], which has caused some confusion. I want every template_fields of all Operators in the API document has marked "(templated)"



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)