kaxil commented on a change in pull request #19013:
URL: https://github.com/apache/airflow/pull/19013#discussion_r729982570
##########
File path: docs/apache-airflow/tutorial.rst
##########
@@ -182,11 +182,11 @@ in templates, make sure to read through the
:ref:`templates-ref`.
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. The DAG documentation can be written as a doc string at the
beginning of the DAG file (recommended)
-or anywhere in the file. Below you can find some examples on how to implement
task and DAG docs,
-as well as screenshots:
+We can add documentation for DAG or each single task. DAG documentation only
supports
+markdown so far, while task documentation supports plain text, markdown,
reStructuredText,
+json, and yaml. The DAG documentation can be written as a doc string at the
beginning
+of the DAG file (recommended), or anywhere else in the file. Below you can
find some examples
Review comment:
```suggestion
of the DAG file (recommended), or anywhere else in the file. Below you can
find some examples
```
##########
File path: docs/apache-airflow/tutorial.rst
##########
@@ -182,11 +182,11 @@ in templates, make sure to read through the
:ref:`templates-ref`.
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. The DAG documentation can be written as a doc string at the
beginning of the DAG file (recommended)
-or anywhere in the file. Below you can find some examples on how to implement
task and DAG docs,
-as well as screenshots:
+We can add documentation for DAG or each single task. DAG documentation only
supports
+markdown so far, while task documentation supports plain text, markdown,
reStructuredText,
+json, and yaml. The DAG documentation can be written as a doc string at the
beginning
Review comment:
```suggestion
json, and yaml. The DAG documentation can be written as a doc string at the
beginning
```
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
