Add returnParameters in SourceContractItem alongside with parameters

Aperta
#300 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Start by locating SourceContractItem and the code that maps ast.parameters to args. Inspect how solc return values are represented and how natspec.returns is populated; done when return parameters are exposed independently of return documentation, with the astNode proposal treated as a separate scope decision.

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

Descrizione

Current version of solidity-docgen exposes ast.parameters as args but doesn't expose return values. It's important because natspec.returns only shows return args that were documented which isn't always the case.

It may be worthwhile to expose this.astNode itself so users can always access what they need from solc 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.