foundry-rs/forge-std

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

Open

#394 aberto em 29 de mai. de 2023

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Solidity (499 forks)user submission
documentationgood first issue

Métricas do repositório

Stars
 (1.041 stars)
Métricas de merge de PR
 (Mesclagem média 12m) (3 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Encontre a seção relevante no código (Vm.sol) e atualize a documentação NatSpec para parseJsonString e funções relacionadas, explicitando que o parâmetro key deve começar com um ponto.
Pilha de tecnologia
None
Domain
backenddeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JSON basicsforge std basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85