Diederik van Liere created AIRFLOW-4018:
-------------------------------------------
Summary: Status of task documentation is unclear
Key: AIRFLOW-4018
URL: https://issues.apache.org/jira/browse/AIRFLOW-4018
Project: Apache Airflow
Issue Type: Bug
Affects Versions: 1.10.2
Reporter: Diederik van Liere
There is a discrepancy between the docs and the actual support for adding
documentation to a task.
On the one hand, [https://airflow.apache.org/concepts.html#documentation-notes]
mentions support of adding documentation to an instance of Task, and
[https://github.com/apache/airflow/blob/master/airflow/example_dags/tutorial.py#L71-L77]
shows how to do it. And
[https://github.com/apache/airflow/blob/master/airflow/www/utils.py#L347-L359]
has support for rendering the different doc types.
At the same time, that code from the tutorial does not work: it throws an
`AttributeError`.
What's the path forward? Fix the code or fix the docs?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
