Repository navigation
Python: Make response overview examples runnable - #9617
Open
BlueRaddish wants to merge 1 commit into
Open
BlueRaddish wants to merge 1 commit into
BlueRaddish wants to merge 1 commit into
Conversation
AI-assisted with OpenAI Codex.
This branch was successfully 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
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.
Motivation & Context
The
ChatResponseandAgentResponseoverview code blocks use an illustrativeupdates = [...]placeholder. Copying either complete block stops atfrom_updatesbefore its serialization examples becauseEllipsisis not a response update. Concrete updates let readers run each overview as written.Description & Review Guide
Content, then construct a single assistant text update in each overview.Actual verification catches two
AttributeErrorinterruptions when copying the original complete blocks, with three passing public API controls. Both final blocks execute through real public imports, including their printed values and both serialization round trips. The actual code blocks compile under Python 3.10 and 3.11. All 482 owningtest_types.pyunit tests pass with zero skips. Normal scoped hooks and the native source commit's normal pre-commit hook pass. Exact source verification. Runtime execution used Ubuntu/CPython 3.13; the full workspace suite, build, typing and live service calls were not run.Related Issue
N/A - trivial change. This replaces illustrative placeholders with minimal concrete inputs in existing overview examples; runtime behavior is unchanged. The separate #9437 edits the
to_updatesmethod examples, not these class overviews. Fresh targeted issue/PR searches found no competing overview repair.AI Assistance
AI assistance details: OpenAI Codex assisted with the example inputs, documentation patch, verification and this description.
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.