foundry-rs/forge-std

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

Open

#394 geöffnet am 29. Mai 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Solidity (499 Forks)user submission
documentationgood first issue

Repository-Metriken

Stars
 (1.041 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12m) (3 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Finde den relevanten Abschnitt im Code (Vm.sol) und aktualisiere die NatSpec Dokumentation für parseJsonString und verwandte Funktionen, um explizit anzugeben, dass der key Parameter mit einem Punkt beginnen muss.
Tech Stack
Keine
Domain
backenddeveloper experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JSON basicsforge std basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85