foundry-rs/forge-std

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

Open

#394 ouverte le 29 mai 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Solidity (499 forks)user submission
documentationgood first issue

Métriques du dépôt

Stars
 (1 041 stars)
Métriques de merge PR
 (Merge moyen 12m) (3 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Trouvez la section pertinente dans le code (Vm.sol) et mettez à jour la documentation NatSpec pour parseJsonString et les fonctions associées, en précisant explicitement que le paramètre key doit commencer par un point.
Stack technique
Aucun
Domaine
backenddeveloper experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JSON basicsforge std basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85