BugFix: fix DAG doc display (especially for TaskFlow DAGs) #14564
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue and Background
Let's take the example DAG
tutorial_taskflow_api_etl
as example. In 2.0.1, the DAG doc in Markdown format is not rendered properly.If it's rendered properly, it should look like the DAG Docs of another example DAG,
tutorial
,Why
Because of how TaskFlow DAGs are constructed, their
__doc__
lines may start with spaces. This failsmarkdown.markdown()
, and the doc in Markdown format cannot be transformed into HTML properly, and further fails the doc display in the UI.Actually this also affects the non-TaskFlow DAGs (if users accidentally add a space in the beginning of any line in the
__doc__
)Output:
Solution
This commit fixes this by always doing left strip for each line of the doc md.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.