[Docs] Rename container_image to image for improved UX #6211
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
Signed-off-by: JiangJiaWei1103 <waynechuang97@gmail.com>
Code Review Agent Run Status
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6211 +/- ##
=======================================
Coverage 36.90% 36.90%
=======================================
Files 1317 1317
Lines 134061 134061
=======================================
+ Hits 49474 49479 +5
+ Misses 80294 80289 -5
Partials 4293 4293
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
This was referenced Feb 3, 2025
| @@ -17,7 +17,7 @@ For example, [flytekitplugins-envd](https://github.com/flyteorg/flytekit/blob/c0 | |||
| For every {py:class}`flytekit.PythonFunctionTask` task or a task decorated with the `@task` decorator, | |||
| you can specify rules for binding container images. By default, flytekit binds a single container image, i.e., | |||
| the [default Docker image](https://ghcr.io/flyteorg/flytekit), to all tasks. To modify this behavior, | |||
| use the `container_image` parameter available in the {py:func}`flytekit.task` decorator, and pass an | |||
| use the `image` parameter available in the {py:func}`flytekit.task` decorator, and pass an | |||
There was a problem hiding this comment.
Not sure I follow
I still see container_image as the arg name in the task API
https://docs.flyte.org/en/latest/api/flytekit/generated/flytekit.task.html
I think there's some discussion around changing it to be image indeed but not in effect AFAIK
wild-endeavor
approved these changes
Feb 12, 2025
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.
Tracking issue
NA
Why are the changes needed?
To enhance the user experience, the concept of
containershould be abstracted from flytekit users.What changes were proposed in this pull request?
Rename
container_imagetoimageforflytekit.task()decorator.Check all the applicable boxes
Related PRs
flyteorg/flytekit#3094
Docs link