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

(0 comments) (0 reactions) (0 assignees)Solidity (1,041 stars) (499 forks)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
Issue 種別: 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.