Allow setting TaskGroup tooltip via function docstring #26028
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Should a note be added to the documentation on this? |
phanikumv
reviewed
Aug 29, 2022
josh-fell
force-pushed
the
task-group-deco-tooltip
branch
from
d141cdd
to
b1be256
Compare
Definitely would be nice. Sadly #20762 is still open so we don't have docs for this decorator explicitly. However, the TaskGroup section in the Concepts doc might be a good first start. (And to transition to the decorator style in examples too.) Is that acceptable for now? |
uranusjr
approved these changes
Aug 30, 2022
mik-laj
approved these changes
Sep 6, 2022
As a natural extension of authoring practices by adding docstrings to functions, DAG authors may find it useful to utilize the existing function's docstring as a TaskGroup tooltip for other users looking the the DAG itself; especially for those who wouldn't necessarily have access to the underlying code. This PR will set the TaskGroup's tooltip of a `@task_group`-decorated function with its docstring should it exist. However, if a tooltip value is explicitly set, the docstring will _not_ be used.
josh-fell
force-pushed
the
task-group-deco-tooltip
branch
from
beb8564
to
623ae92
Compare
uranusjr
approved these changes
Sep 6, 2022
Open
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DAG authors may find it useful to utilize the existing function's docstring as a TaskGroup tooltip for other users looking the the DAG itself; especially for those who wouldn't necessarily have access to the underlying code.
This PR will set the TaskGroup's tooltip of a
@task_group-decorated function with its docstring should it exist. However, if a tooltip value is explicitly set, the docstring will not be used.^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an 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 a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.