foundry-rs/forge-std

docs(StdJson): document that key parameter must start with a dot

Open

#394 创建于 2023年5月29日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Solidity (1,041 star) (499 fork)user submission
documentationgood first issue

描述

The current documentation for the JSON cheats does not explain that the key parameter must be provided with a leading dot:

https://github.com/foundry-rs/forge-std/blob/e8a047e3f40f13fa37af6fe14e6e06283d9a060e/src/Vm.sol#L213-L239

I was trying to access the key by its simple name, like so:

string memory json = '{"bar":"Hello World"}';
string memory bar = vm.parseJsonString(json, "bar");

And that didn't work until I added the leading dot, i.e. .bar.

Side note: the parameters for the parseJsonSOMETHING cheats have been left unnamed.

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
95
研究方向
The issue points to the documentation for the `parseJsonString` cheatcode in `src/Vm.sol` (lines 213-239). The contributor should add a note that the `key` parameter must start with a leading dot (e.g., `.bar`). Additionally, consider addressing the side note that the parameters for `parseJsonSOMETHING` cheats are left unnamed, which could be improved by adding parameter names in the NatSpec comments.