Fix docs assets.rst : use AssetAlias for alias in Metadata example #50768
Conversation
This file contains hidden or 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
|
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
kaxil
approved these changes
May 22, 2025
kaxil
added
the
backport-to-v3-1-test
uranusjr
approved these changes
May 22, 2025
|
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
github-actions bot
pushed a commit
that referenced
this pull request
May 23, 2025
…a` example (#50768) This PR fixes an inconsistency in the `assets.rst` documentation example. The sample code used a plain string for the `alias` argument in `Metadata()`, which in reality raises: > TypeError: Key should be either an asset or an asset alias, not <class 'str'> This change updates the example to use a typed `AssetAlias("my-task-outputs")`, matching the SDK API and avoiding that error. (cherry picked from commit ed67114) Co-authored-by: QBidolet <52286815+QBidolet@users.noreply.github.com>
Backport successfully created: v3-0-test
|
github-actions bot
pushed a commit
to aws-mwaa/upstream-to-airflow
that referenced
this pull request
May 23, 2025
…a` example (apache#50768) This PR fixes an inconsistency in the `assets.rst` documentation example. The sample code used a plain string for the `alias` argument in `Metadata()`, which in reality raises: > TypeError: Key should be either an asset or an asset alias, not <class 'str'> This change updates the example to use a typed `AssetAlias("my-task-outputs")`, matching the SDK API and avoiding that error. (cherry picked from commit ed67114) Co-authored-by: QBidolet <52286815+QBidolet@users.noreply.github.com>
shahar1
pushed a commit
that referenced
this pull request
May 24, 2025
…a` example (#50768) (#51000) This PR fixes an inconsistency in the `assets.rst` documentation example. The sample code used a plain string for the `alias` argument in `Metadata()`, which in reality raises: > TypeError: Key should be either an asset or an asset alias, not <class 'str'> This change updates the example to use a typed `AssetAlias("my-task-outputs")`, matching the SDK API and avoiding that error. (cherry picked from commit ed67114) Co-authored-by: QBidolet <52286815+QBidolet@users.noreply.github.com>
dadonnelly316
pushed a commit
to dadonnelly316/airflow
that referenced
this pull request
May 26, 2025
…pache#50768) This PR fixes an inconsistency in the `assets.rst` documentation example. The sample code used a plain string for the `alias` argument in `Metadata()`, which in reality raises: > TypeError: Key should be either an asset or an asset alias, not <class 'str'> This change updates the example to use a typed `AssetAlias("my-task-outputs")`, matching the SDK API and avoiding that error.
kaxil
pushed a commit
that referenced
this pull request
Jun 3, 2025
…a` example (#50768) (#51000) This PR fixes an inconsistency in the `assets.rst` documentation example. The sample code used a plain string for the `alias` argument in `Metadata()`, which in reality raises: > TypeError: Key should be either an asset or an asset alias, not <class 'str'> This change updates the example to use a typed `AssetAlias("my-task-outputs")`, matching the SDK API and avoiding that error. (cherry picked from commit ed67114) Co-authored-by: QBidolet <52286815+QBidolet@users.noreply.github.com>
sanederchik
pushed a commit
to sanederchik/airflow
that referenced
this pull request
Jun 7, 2025
…pache#50768) This PR fixes an inconsistency in the `assets.rst` documentation example. The sample code used a plain string for the `alias` argument in `Metadata()`, which in reality raises: > TypeError: Key should be either an asset or an asset alias, not <class 'str'> This change updates the example to use a typed `AssetAlias("my-task-outputs")`, matching the SDK API and avoiding that error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR fixes an inconsistency in the
assets.rstdocumentation example.The sample code used a plain string for the
aliasargument inMetadata(), which in reality raises:This change updates the example to use a typed
AssetAlias("my-task-outputs"), matching the SDK API and avoiding that error.^ 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 airflow-core/newsfragments.