You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/07/04 09:42:21 UTC
[GitHub] [airflow] matwasilewski opened a new issue, #24822: Add documentation for TaskFlowAPI branching and update the tutorial
matwasilewski opened a new issue, #24822:
URL: https://github.com/apache/airflow/issues/24822
### What do you see as an issue?
When learning Airflow, I could not find documentation for branching in TaskFlowAPI. I finally found `@task.branch(task_id="<TASK_ID>")` via an example from [the github repo ](https://github.com/apache/airflow/blob/f1a9a9e3727443ffba496de9b9650322fdc98c5f/airflow/example_dags/example_branch_operator_decorator.py#L43) - but it seems to be the only place where this feature is mentioned, which makes it very difficult to find.
### Solving the problem
I suggest adding "branching in TaskFlowAPI" to the official documentation, and including an example of branching in TaskFlowAPI Tutorial. I would be happy to update the docs.
### Anything else
Generally, my feeling is that the TaskFlowAPI is still poorly documented and has a long way to go - so if there were any other elements that should be added to the docs together with information about branching let me know and I am happy to write that docs.
### Are you willing to submit PR?
- [X] Yes I am willing to submit a PR!
### Code of Conduct
- [X] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
--
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: commits-unsubscribe@airflow.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on issue #24822: Add documentation for TaskFlowAPI branching and update the tutorial
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #24822:
URL: https://github.com/apache/airflow/issues/24822#issuecomment-1173672535
I assigned you!
Absolutely! Feel free to update the docs! Airflow is created by > 2100 contributors like you - including the docs :). Having contributions for the users in the docs where they find missing information is the most valuable contributions - as a user who struggled with and finally found answer and tried it, you are uniquely positioned to be one of the best people who could do it well :). The creators of Async API have too many assumptions in their heads, many things are "obvious" to them, so their docuementation is never perfect for users like you, who just learn.
BTW. You might not realise how easy, it is to contribute the docs. Simply go to the documentation and choose "Suggest a change on this page" button at the bottom right - and it will automatically open a PR in GitHub where you will be able to edit the documentation using GitHub UI. Only if you need some complex case (like embedding examples) you might need to setup the development environment - but for documentation it is very easy using `breeze` that takes literally minutes to setup. See https://github.com/apache/airflow/blob/main/CONTRIBUTORS_QUICK_START.rst
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation for TaskFlowAPI branching and update the tutorial [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #24822:
URL: https://github.com/apache/airflow/issues/24822#issuecomment-1777218805
assigned
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on issue #24822: Add documentation for TaskFlowAPI branching and update the tutorial
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on issue #24822:
URL: https://github.com/apache/airflow/issues/24822#issuecomment-1173596558
Thanks for opening your first issue here! Be sure to follow the issue template!
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation for TaskFlowAPI branching and update the tutorial [airflow]
Posted by "dylanzenner (via GitHub)" <gi...@apache.org>.
dylanzenner commented on issue #24822:
URL: https://github.com/apache/airflow/issues/24822#issuecomment-1777215272
Can I take this? I work with airflow daily and just recently had the same issue as this person but I also needed to figure out how branching worked with task groups.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org