Skip to content

docs(graphs): fix graph workflow samples and behavior claims - #2022

Open
GWeale wants to merge 2 commits into
google:mainfrom
GWeale:docs-audit-graphs
Open

docs(graphs): fix graph workflow samples and behavior claims#2022
GWeale wants to merge 2 commits into
google:mainfrom
GWeale:docs-audit-graphs

Conversation

@GWeale

@GWeale GWeale commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Corrections to the docs/graphs/ pages (plus one note on docs/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 that yields is an async generator, so the sample's bare return code emitted nothing; it now yields Event(output=code). Also FunctionNode(func=...) as a keyword, @node(rerun_on_resume=True) on workflow nodes, and the parallel sample no longer takes a real_node argument no caller could supply — it defines the worker node and passes use_sub_branch=True.
  • docs/graphs/index.md — live streaming was listed as flatly unsupported. It is the default single_turn node mode that ignores the live request queue; nodes in task or chat mode can stream.
  • docs/graphs/data-handling.md — dropped the {CityTime.time_info} / <field from node> data-selection syntax, which does not exist; instruction placeholders are substituted from session state, so an unmatched one is left in the prompt verbatim. Also corrected the multi-yield description (each yield emits a separate Event and only one may carry output) and the state-print / node-input parameter names.
  • docs/graphs/routes.mdJoinNode waits on upstream completion, not output (completing with no output gives None; a node that never runs stalls the join). A workflow may have at most one output-producing terminal node, else ValueError. chat mode agents are only allowed directly after START, and a cycle needs at least one routed edge; the loop sample now actually loops.
  • docs/graphs/human-input.md — replaced the RequestInput sample with the tool-confirmation API (FunctionTool(..., require_confirmation=True) and tool_context.request_confirmation()), and linked the full confirmation page.
  • docs/workflows/patterns.md — added a note that SequentialAgent, ParallelAgent and LoopAgent are deprecated in Python and emit a DeprecationWarning.

How this was produced

Part of a page-by-page audit of the Python docs against the google/adk-python v2.5.0 source: every import resolved against a real 2.5.0 install, every constructor kwarg checked against model_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 --strict is 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.

@netlify

netlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit 1296e05
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6a6a9991b11baa000880d825
😎 Deploy Preview https://deploy-preview-2022--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant