Do not expect that first word in comment line is name of result variable

Aperta
#301 5 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
45/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
solidity, typescript
Ambito
documentation

Direzione di ricerca

Start by locating the parseNatSpec function and reading the linked NatSpec return-format reference. Confirm how a single unnamed return description such as “Some value” is parsed, then add coverage showing that “Some” is not treated as a result variable name and the description is preserved.

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

Descrizione

Consider following method and comment:

/// @return Some value
function foo() external view returns(uint256) {
    return 0;
}

When it get parsed with parseNatSpec function it parses Some as response variable name and the rest as its description. But natspec doesn't have any requirements on format of return and it makes total sense to omit it at all when there is only one return value

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.