[docs][examples] Clarify prompt brace handling and use single braces in JSON examples#810
Merged
Merged
Conversation
…in JSON examples
SafeFormatter (Python) and Prompt.formatMessages (Java) only substitute
{key}; they do not collapse {{ }} to { }. Doubled braces reach the LLM
verbatim, which may copy them into replies and break downstream json.loads.
- Document the actual brace rules; drop the wrong "double to escape" note.
- Switch all JSON examples in docs and the quickstart example to single
braces. Cross-reference from yaml.md.
Closes apache#781
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
doc-included
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.
Linked issue: #781
Purpose of change
SafeFormatter (Python) and Prompt.formatMessages (Java) only substitute {key}; they do not collapse {{ }} to { }. Doubled braces reach the LLM verbatim, which may copy them into replies and break downstream json.loads.
Tests
ut & e2e
API
no
Documentation
doc-neededdoc-not-neededdoc-included