foundry-rs/forge-std

docs: enhance documentation with NatSpec for all public functions

Open

#653 aberto em 4 de fev. de 2025

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)Solidity (499 forks)user submission
documentationhelp wanted

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

Related: https://github.com/foundry-rs/book/issues/1303

To do:

Goals:

  • Document all public facing functions with @notice
  • Mark private variables and functions with underscore prefix https://github.com/foundry-rs/forge-std/pull/861
  • Unify layouts to follow common best practices of grouping storage variables
  • Move internal functions up, private functions down
  • Should not modify any user facing function or interface

This will make it easier to autogenerate documentation that we can then load into https://book.getfoundry.sh/reference/forge-std/ and keep it up to date

Guia do colaborador

Direção de pesquisa
Adicione comentários NatSpec @notice às funções públicas nos arquivos Solidity listados (Base.sol, console.sol, etc.) seguindo as metas: garanta que cada função pública tenha @notice, marque variáveis/funções privadas com prefixo sublinhado, unifique os layouts das variáveis de armazenamento, mova funções internas para cima e funções privadas para baixo, e não modifique funções ou interfaces voltadas ao usuário. Gere documentação automaticamente para o livro Foundry.
Pilha de tecnologia
None
Domain
documentationtesting
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
SolidityGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80