foundry-rs/forge-std

docs: enhance documentation with NatSpec for all public functions

Open

#653 ouverte le 4 févr. 2025

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)Solidity (499 forks)user submission
documentationhelp wanted

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

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

Guide contributeur

Direction de recherche
Ajoutez des commentaires NatSpec @notice aux fonctions publiques dans les fichiers Solidity listés (Base.sol, console.sol, etc.) en suivant les objectifs : assurez vous que chaque fonction publique a @notice, marquez les variables/fonctions privées avec un préfixe de soulignement, unifiez les dispositions des variables de stockage, déplacez les fonctions internes vers le haut et les fonctions privées vers le bas, et ne modifiez pas les fonctions ou interfaces destinées aux utilisateurs. Générez automatiquement la documentation pour le livre Foundry.
Stack technique
Aucun
Domaine
documentationtesting
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
SolidityGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80