Zhnz commented on issue #74018:
URL: https://github.com/apache/airflow/issues/74018#issuecomment-6025036078

   @Mola-maker Thanks for your PR! Reading your analysis made me realise that 
HITLOperator bodies are rendered as Markdown. In that case the current 
behaviour probably makes sense. In Markdown singular newlines get translated 
into spaces. The issue then becomes making the user aware that the body is 
actually Markdown. The current documentation does not a good job of informing 
the user of the Markdown rendering. Now that I explicitly searched for the 
HITLOperator parameters, I found this page where it is stated: 
https://airflow.apache.org/docs/apache-airflow-providers-standard/stable/_api/airflow/providers/standard/operators/hitl/index.html#airflow.providers.standard.operators.hitl.ApprovalOperator
   Maybe this is something that should be mentioned on the actual [HITLOperator 
Tutorial](https://airflow.apache.org/docs/apache-airflow/stable/tutorial/hitl.html),
 because that is the first page that shows up when searching for it.


-- 
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]

Reply via email to