Support custom errors

Aperta
#342 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

@frangio ci sta già lavorando.

Dal 10/12/2021.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
solidity
Ambito
documentation

Direzione di ricerca

Start by reproducing the Markdown report with the linked BalanceSheet contract and inspect the report-generation and custom-error configuration paths. Done means custom errors can be configured and then appear in the generated Markdown output.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Custom errors cannot be configured to be included in the Markdown report.

When I run solidity-docgen over a contract with lots of custom errors (such as the BalanceSheet), the custom errors are not included in the output.

Lingua principale
TypeScript
Stelle
460
Fork
111
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenZeppelin/solidity-docgen

Tutte le issue di OpenZeppelin/solidity-docgen

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.