You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "fritz-astronomer (via GitHub)" <gi...@apache.org> on 2025/11/18 18:56:57 UTC
[I] Missing Documentation - TaskGroup Parameters [airflow]
fritz-astronomer opened a new issue, #58446:
URL: https://github.com/apache/airflow/issues/58446
### What do you see as an issue?
There doesn't appear to be any way to see the parameters for a TaskGroup (and likely other public sdk objects?)
### Solving the problem
- The public interface page only has text for the name, with no further documentation
https://airflow.apache.org/docs/apache-airflow/stable/public-airflow-interface.html
- The "core concepts" page doesn't describe any of the possible parameters beyond `default args
https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/dags.html#taskgroups
- I don't see any other meaningful references in search
https://airflow.apache.org/docs/apache-airflow/stable/search.html?q=taskgroup&check_keywords=yes&area=default
### Anything else
_No response_
### Are you willing to submit PR?
- [ ] 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
Re: [I] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3549607629
> The proper documentation is here: https://airflow.apache.org/docs/task-sdk/stable/api.html#airflow.sdk.TaskGroup However that's not at all obvious or easily find-able if you're not familiar or looking at the main airflow docs.
Marked it as good first issue - and if you have a better and more obvious place and want to fix it without waiting until someone volunteers - feel free to contribute 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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "steveahnahn (via GitHub)" <gi...@apache.org>.
steveahnahn commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3583721550
I had opened a PR on this a few days ago sorry didn't ping here, let me know if its sufficient: https://github.com/apache/airflow/pull/58511
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "fritz-astronomer (via GitHub)" <gi...@apache.org>.
fritz-astronomer commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3549107113
The proper documentation is here:
https://airflow.apache.org/docs/task-sdk/stable/api.html#airflow.sdk.TaskGroup
However that's not at all obvious or easily find-able if you're not familiar or looking at the main airflow docs.
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3569860333
I think it's mostly question to @fritz-astronomer -> but again, I think discussions on something like that are better on PR, often it's faster to propose something and iterate on it in the PR - this will show your understanding and proposal, and if @fritz-astronomer will have doubts and proposal how to iterate on it, he wil do.
Generally - we prefer to discuss on a concrete proposl rather than excessive discussion before the proposal is made - it's usually easier to iterate on a concrete PR than abstract discusssion
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "kngoyal (via GitHub)" <gi...@apache.org>.
kngoyal commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3550579418
@potiuk - can you please assign this to me
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "prdk0 (via GitHub)" <gi...@apache.org>.
prdk0 commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3568822821
@potiuk thank you for assigning to me
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "prdk0 (via GitHub)" <gi...@apache.org>.
prdk0 commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3570130670
@potiuk got it, Then I will make a PR.
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "prdk0 (via GitHub)" <gi...@apache.org>.
prdk0 commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3567931032
Hi, I'm new to opensource code contribution, can I work on this ?
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3568349118
> Hi, I'm new to opensource code contribution, can I work on this ?
If you will be able to read the contributing docs (which are pretty good) and follow your ways to a successful contribution (green PR) without too much of manual guidance and taking time of maintainers, then yes. I will assign you.
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "prdk0 (via GitHub)" <gi...@apache.org>.
prdk0 commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3568872482
@potiuk let me clarify on the issues that @fritz-astronomer has mentioned before getting to the work,
The issue, as you correctly noted, is that the high-level documentation pages fail to link directly to or include the full list of TaskGroup constructor parameters, which are mentioned in the API reference docs, like:
group_id, prefix_group_id, parent_group, dag etc.
Am I correct in my understanding of the issue?
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk closed issue #58446: Unclear Documentation - TaskGroup Parameters
URL: https://github.com/apache/airflow/issues/58446
--
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] Unclear Documentation - TaskGroup Parameters [airflow]
Posted by "fritz-astronomer (via GitHub)" <gi...@apache.org>.
fritz-astronomer commented on issue #58446:
URL: https://github.com/apache/airflow/issues/58446#issuecomment-3571568571
But, yes, @prdk0 - ultimately, I think I was expected a few `TaskGroup` references in the primary documentation to link to
https://airflow.apache.org/docs/task-sdk/stable/api.html#airflow.sdk.TaskGroup
which has the details on what parameters are available
--
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