Natspec-only docs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 38/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- solidity, typescript
- Ambito
- documentation
Direzione di ricerca
Start by tracing configuration handling and how documentation entries are selected for contracts, interfaces, libraries, functions, and events. Verify that a Natspec-only option excludes undocumented internal and private items while retaining documented entries, then add or run the relevant tests.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Could we have an config option to only generate docs for items with natspec documentation, i.e. contracts, interfaces, libraries, functions, and events. I comment all these accordingly, but often have uncommented internal/private items. As such, the generated docs have many redundant entries. It would be nice to have a natspec only option.
- 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
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
jeanibarz/knowledge-base-mcp-server#1268 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
Koenkk/zigbee-herdsman-converters#13820 ·
I maintainer di solito rispondono entro 2 giorni
-
[prefer-expect-resolves] autofix leaves a stray ")" when the awaited expression is parenthesizedAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
jest-community/eslint-plugin-jest#2052 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
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