Guide for templates based on specified requirements
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- solidity, typescript
- Ambito
- documentation, tooling
Direzione di ricerca
The request concerns template design and the -t templates_dir option for generating Solidity documentation. Start by reviewing the existing template and command-option documentation, if present. Done means providing a guide that explains template customization and how to represent the requested filtering and formatting requirements.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I need to generate docs for contracts with next requirements:
- All documented methods from base class should be inside derived class.
- All methods with keyword
internalandprivateshouldn't be inside generated docs - Function modifiers shouldn't be inside docs.
Is it possible? Should I use option -t templates_dir? Where can I find the guide of designing templates
- 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
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di OpenZeppelin/solidity-docgen
-
Support for Hardhat 3Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
OpenZeppelin/solidity-docgen#471 · 2 reazioni ·
-
using $ as a return parameter name doesn't workForse già presa @pucedoteth l’ha presa 56 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
OpenZeppelin/solidity-docgen#464 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
OpenZeppelin/solidity-docgen#454 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 48/100
OpenZeppelin/solidity-docgen#439 · 2 commenti ·
-
Use docgen in the browserAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
OpenZeppelin/solidity-docgen#437 · 4 commenti ·
Tutte le issue di OpenZeppelin/solidity-docgen
Issue simili
-
Wallet functions throws TypeError when the wallet has no account IDForse già presa @Medhansh-741 l’ha presa oggi. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
hiero-ledger/hiero-sdk-js#4781 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
dataforgoodfr/mediterranean-rescue#91 ·
I maintainer di solito rispondono entro 1 giorno
-
transformer-directives: `@apply` drops a utility whose CSS is a substring of an earlier one'sForse già presa Una pull request collegata a questa issue è aperta o già unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
-
Add: KRT TVApertaapproved check:passed streams:add
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
iptv-org/iptv#58647 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
milind-soni/OpenMausBot#5829 ·
I maintainer di solito rispondono entro 1 giorno