foundry-rs/forge-std

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

Open

#394 aperta il 29 mag 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Solidity (499 fork)user submission
documentationgood first issue

Metriche repository

Star
 (1041 star)
Metriche merge PR
 (Merge medio 12m) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Trova la sezione pertinente nel codice (Vm.sol) e aggiorna la documentazione NatSpec per parseJsonString e funzioni correlate, specificando esplicitamente che il parametro key deve iniziare con un punto.
Tech stack
Nessuno
Dominio
backenddeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JSON basicsforge std basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85