Update admonitions in Python operator doc to reflect sentiment #36340
Conversation
Within the Python operator how-to guide, there are doc admonitions that don't necessarily reflect the sentiment of the call-out. For example, there are several places where there is a recommendation to use the TaskFlow version of an operator but the admonition is a warning; this is more of a tip when authoring DAGs. This PR hopes to match the sentiment of the call-out with an "appropriate" admonition in the doc for better context and visbility when reading the doc.
boring-cyborg
bot
added
area:core-operators
|
Should it help on what the new version would look like for context: Screen.Recording.2023-12-20.at.10.11.58.PM.mov |
|
Just checked https://airflow.apache.org/docs/apache-airflow/stable/howto/operator/python.html. It currently looks like |
Glad to hear it! I think it might behoove us to modify the styling for these admonitions on the site (e.g. maybe "warning" shouldn't be gray?), plus I think there tends to be an overuse of "warning" and that might be copy/paste or just potential styling choice, not sure. |
+1, grey it is looks like something unimportant |
|
I had to look up what |
Within the Python operator how-to guide, there are doc admonitions that don't necessarily reflect the sentiment of the call-out. For example, there are several places where there is a recommendation to use the TaskFlow version of an operator but the admonition is a warning; this is more of a tip when authoring DAGs. This PR hopes to match the sentiment of the call-out with an "appropriate" admonition in the doc for better context and visbility when reading the doc. (cherry picked from commit f76060c)
Within the Python operator how-to guide, there are doc admonitions that don't necessarily reflect the sentiment of the call-out. For example, there are several places where there is a recommendation to use the TaskFlow version of an operator, but the admonition is a warning; this is more of a tip when authoring DAGs.
This PR hopes to match the sentiment of the call-out with an "appropriate" admonition for better context and visibility when reading the doc.