<#964 docs: enhance TaskEnvironment and Image.clon...
# flyte-github
a
#964 docs: enhance TaskEnvironment and Image.clone() docstrings Pull request opened by ppiegaze Summary Follow-up to #810. Restores information that was lost when user-guide reference content was trimmed in unionai/unionai-docs#854. TaskEnvironment class docstring (
_task_environment.py
): • `name`: add fully-qualified name composition explanation (
<env_name>.<function_name>
) • `reusable`: document the override interaction — overriding `resources`/`env_vars`/`secrets` in
task.override()
requires
reusable="off"
in the same call • `queue`: explain that queues identify compute infrastructure partitions
task()
method docstring
(
_task_environment.py
): • `short_name`: note that overriding it doesn't change the task's FQN • `retries`: document
RetryStrategy
alternative to
int
• `timeout`: document `timedelta`/`int` alternatives and
0
= no timeout • `max_inline_io_bytes`: add 10 MiB default value
Image.clone()
(
_image.py
): • Clarify purpose vs
with_*
methods (all
with_*
methods already produce new immutable images) Context An audit of PR #810 + unionai-docs #854 found that the
TaskEnvironment
class was the only class (out of 12 enhanced) where the docstring migration was incomplete. The
task()
method docstring was not touched at all by #810, leaving decorator-only parameters with sparse one-liners. Test plan •
uv run python -c "import flyte; help(flyte.TaskEnvironment)"
renders correctly • Regenerate API docs and verify enhanced content appears in the Parameters table 🤖 Generated with Claude Code flyteorg/flyte-sdk