foundry-rs/forge-std

docs: enhance documentation with NatSpec for all public functions

Open

#653 aperta il 4 feb 2025

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)Solidity (499 fork)user submission
documentationhelp wanted

Metriche repository

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

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiungi commenti NatSpec @notice alle funzioni pubbliche nei file Solidity elencati (Base.sol, console.sol, ecc.) seguendo gli obiettivi: assicurati che ogni funzione pubblica abbia @notice, contrassegna variabili/funzioni private con prefisso underscore, unifica i layout delle variabili di storage, sposta le funzioni interne in alto e quelle private in basso, e non modificare funzioni o interfacce rivolte all'utente. Genera automaticamente la documentazione per il libro Foundry.
Tech stack
Nessuno
Dominio
documentationtesting
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
SolidityGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80