Skip to content

Clarify stdJson key syntax#832

Open
tn0vak wants to merge 1 commit intofoundry-rs:masterfrom
tn0vak:jsonpath
Open

Clarify stdJson key syntax#832
tn0vak wants to merge 1 commit intofoundry-rs:masterfrom
tn0vak:jsonpath

Conversation

@tn0vak
Copy link
Contributor

@tn0vak tn0vak commented Mar 13, 2026

The stdJson docs currently use a generic <json_path> placeholder, but the API actually expects the same selector syntax as vm.parseJson*. The existing tests already show the real usage with .a for a field and $ for the root object in test/StdJson.t.sol, so the current comments are easy to misread.

This updates the StdJson examples and function docs to match the behavior that is already implemented and tested today. It is a comment-only change with no ABI or runtime impact, just a documentation fix that makes the interface clearer and more accurate.

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