dstandish commented on a change in pull request #14853:
URL: https://github.com/apache/airflow/pull/14853#discussion_r596607455
##########
File path: docs/apache-airflow/tutorial.rst
##########
@@ -184,14 +184,21 @@ Adding DAG and Tasks documentation
----------------------------------
We can add documentation for DAG or each single task. DAG documentation only
support
markdown so far and task documentation support plain text, markdown,
reStructuredText,
-json, yaml.
+json, yaml. The DAG documentation must be written in a doc string at the
beggining of the DAG file to be taken
+in account. Below you can find some examples on how to implement task and DAG
docs, as well as screenshots:
Review comment:
> The DAG documentation must be written in a doc string at the beggining
of the DAG file to be taken
in account
This isn't quite true. It just has to be markdown. It only has to be a
module docstring if you want to create it by referencing the variable
`__doc__`.
You could do something like this anywhere in the file:
```
dag.doc_md = """
# Hello
"""
```
But it is true that using doc_md.__doc__ is a convenient and elegant way to
add dag documentation.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
