docs(graphs): fix graph workflow samples and behavior claims - #2022
Open
GWeale wants to merge 2 commits into
Open
docs(graphs): fix graph workflow samples and behavior claims#2022GWeale wants to merge 2 commits into
GWeale wants to merge 2 commits into
Conversation
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Corrections to the
docs/graphs/pages (plus one note ondocs/workflows/patterns.md) where Python samples could not run as written and documented behavior did not match v2.5.0.Changes
docs/graphs/dynamic.md— a node thatyields is an async generator, so the sample's barereturn codeemitted nothing; it now yieldsEvent(output=code). AlsoFunctionNode(func=...)as a keyword,@node(rerun_on_resume=True)on workflow nodes, and the parallel sample no longer takes areal_nodeargument no caller could supply — it defines the worker node and passesuse_sub_branch=True.docs/graphs/index.md— live streaming was listed as flatly unsupported. It is the defaultsingle_turnnode mode that ignores the live request queue; nodes intaskorchatmode can stream.docs/graphs/data-handling.md— dropped the{CityTime.time_info}/<field from node>data-selection syntax, which does not exist;instructionplaceholders are substituted from session state, so an unmatched one is left in the prompt verbatim. Also corrected the multi-yielddescription (eachyieldemits a separate Event and only one may carryoutput) and the state-print / node-input parameter names.docs/graphs/routes.md—JoinNodewaits on upstream completion, not output (completing with no output givesNone; a node that never runs stalls the join). A workflow may have at most one output-producing terminal node, elseValueError.chatmode agents are only allowed directly afterSTART, and a cycle needs at least one routed edge; the loop sample now actually loops.docs/graphs/human-input.md— replaced theRequestInputsample with the tool-confirmation API (FunctionTool(..., require_confirmation=True)andtool_context.request_confirmation()), and linked the full confirmation page.docs/workflows/patterns.md— added a note thatSequentialAgent,ParallelAgentandLoopAgentare deprecated in Python and emit aDeprecationWarning.How this was produced
Part of a page-by-page audit of the Python docs against the
google/adk-pythonv2.5.0 source: every import resolved against a real 2.5.0 install, every constructor kwarg checked againstmodel_fields/inspect.signature, every documented default read off the field. A second independent pass re-derived each claim from source rather than trusting the finding, and a third conformed the new wording to the surrounding pages.mkdocs build --strictis clean.Only Python tabs and language-neutral prose were touched — this audit had no ground truth for the Go / Java / TypeScript SDKs.
Split out of a larger audit branch so each area can be reviewed on its own.