docs(StdJson): document that key parameter must start with a dot · foundry-rs/forge-std#394

(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:

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
預計時間: under 1 hour
活動狀態: stale
清晰度: clear
前置要求: 無
新手友善度: 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.