Excluding certain items from the output

Aperta
#175 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
solidity, typescript
Ambito
documentation

Direzione di ricerca

Start by reading issue #131 to understand the proposed attribute syntax, then trace how the generator selects functions, events, and other items for output. Done means an agreed mechanism lets users mark items such as !no-docs or !hide so they are excluded from generated documentation.

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

Descrizione

It should be possible to hide items (functions, events, etc.) from the output. A potential mechanism is using the same syntax suggested in #131 with an attribute like !no-docs, or !hide.

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.