Conversation
boring-cyborg
Bot
added
area:providers
area:task-sdk
provider:amazon
1 task done
SameerMesiah97
approved these changes
Oct 3, 2026
Sphinx 9 resolves annotation and field types project-wide, which turns a few long-standing docstring mistakes into ambiguous or broken references: a parameter field written as ":param name (int):", return types documented as "object" where the signature already names the real class, batch executor aliases whose names clash with the ECS and Lambda executor aliases, and a Task SDK link to an intersphinx inventory name that does not exist. Claude-Session: https://claude.ai/code/session_01SkLWWaTT1cnFqTT1jhFGxe
Sphinx 8 registers the canonical target of a documented type alias as an object. Importing the core WorkloadKey as _WorkloadKey in the batch executor made its canonical name identical to the Lambda executor's, so the Sphinx 8 docs build failed with a duplicate object description. Sphinx 9 no longer reports that, which is why it only showed up on Python 3.10. Claude-Session: https://claude.ai/code/session_01SkLWWaTT1cnFqTT1jhFGxe
shahar1
force-pushed
the
docs-sphinx9-docstring-fixes
branch
from
October 3, 2026 20:01
9268447 to
780b065
Compare
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
related: #74151
related: #74168
AI Summary
Moving the docs build to Python 3.11 (#74151) moves it from Sphinx 8.1.3 to Sphinx 9.0.4, which resolves annotation and field types project-wide. That turns a few long-standing docstring mistakes into ambiguous or broken references that fail the docs and spellcheck jobs:
vertex_ai/auto_ml.py::param budget_milli_node_hours (int):is not a valid field; Sphinx readbudget_milli_node_hoursas a type name and matched the operators' attributes of that name.compute.py: three methods documented:rtype: objectalthough their signatures already returnInstanceTemplate,InstanceandInstanceGroupManager; the field is removed so the real annotation is rendered. The two class names are added to the spelling wordlist next to the other Compute class names.executors/batch/utils.py:CommandTypeand the alias targetWorkloadKeymatched the same-named aliases in the ECS and Lambda executors.CommandTypeis now annotated as aTypeAliaslike theirs (so it resolves in its own module), and the coreWorkloadKeyis imported under the module-unique name_BatchWorkloadKey, as the ECS executor does with_EcsWorkloadKey(reusing the Lambda executor's_WorkloadKeywould collide as a duplicate object on Sphinx 8).deferred-vs-async-operators.rst::doc:used anairflow:inventory prefix that does not exist; every other cross-package link usesapache-airflow:.The builtin
type/objectwarnings are an upstream Sphinx regression and are handled in #74168.Checks run: amazon
--docs-onlypasses on both Python 3.10 / Sphinx 8.1.3 and Python 3.11 / Sphinx 9.0.4; with both PRs applied,--docs-onlyfor amazon, google, openlineage and task-sdk passes on Python 3.11 / Sphinx 9.0.4, and google spellcheck passes; Breeze mypy on the changed amazon and google modules passes on Python 3.11.Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Opus 5.5) following the guidelines
🤖 Generated with Claude Code
https://claude.ai/code/session_01SkLWWaTT1cnFqTT1jhFGxe