Skip to content

Commit

Permalink
Minor grammar tweaks in docs (apache#19013)
Browse files Browse the repository at this point in the history
  • Loading branch information
ClimbsRocks authored Oct 16, 2021
1 parent d937beb commit ee8e0b3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/apache-airflow/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
on how to implement task and DAG docs, as well as screenshots:

.. exampleinclude:: /../../airflow/example_dags/tutorial.py
:language: python
Expand Down

0 comments on commit ee8e0b3

Please sign in to comment.