foundry-rs/forge-std

docs: enhance documentation with NatSpec for all public functions

Open

#653 geöffnet am 4. Feb. 2025

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)Solidity (499 Forks)user submission
documentationhelp wanted

Repository-Metriken

Stars
 (1.041 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12m) (3 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Fügen Sie NatSpec @notice Kommentare zu den öffentlichen Funktionen in den aufgelisteten Solidity Dateien (Base.sol, console.sol usw.) hinzu, indem Sie die Ziele befolgen: Stellen Sie sicher, dass jede öffentliche Funktion @notice hat, markieren Sie private Variablen/Funktionen mit Unterstrich Präfix, vereinheitlichen Sie die Layouts der Speichervariablen, verschieben Sie interne Funktionen nach oben und private Funktionen nach unten, und ändern Sie keine benutzerorientierten Funktionen oder Schnittstellen. Generieren Sie automatisch Dokumentation für das Foundry Buch.
Tech Stack
Keine
Domain
documentationtesting
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
SolidityGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80