Docs/fix template variable in instruction examples#1994
Open
Syed-Umer-Ali wants to merge 1 commit into
Open
Conversation
…s across 5 languages
✅ 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
1 participant
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.
What
Instruction strings across all 5 language examples in docs/agents/llm-agents.md
and the corresponding snippet files contain {country} as a documentation
placeholder inside the example query.
Why
ADK's template engine treats {var} as a state variable injection token. The
docs themselves state (line 127-128): "If the state variable ... does not exist,
the agent will raise an error." Since country is never set as a state variable
in any of these examples, running the code as-written fails with a template
resolution error.
Fix
Replace {country} with {{country}} in all instruction strings across Python,
TypeScript, Java (inline in docs/agents/llm-agents.md), Go
(examples/go/snippets/agents/llm-agents/snippets/main.go), and Kotlin
(examples/kotlin/snippets/agents/llm-agent/CapitalAgent.kt). Double-braces
escape ADK's template engine, rendering a literal {country} in the LLM
instruction — which is what the example intends.
Verification
Confirmed that {var} is documented as state variable syntax on the same page
(lines 123-128). The fix preserves the displayed output while preventing template
engine errors. Python f-strings containing {country} in actual code (e.g., line
239) were left untouched.