using $ as a return parameter name doesn't work

Aperta
  • Qualcosa non va?
#464 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

@pucedoteth ci sta già lavorando.

Dal 18/9/2026.

  • #486 di @pucedoteth — aperta

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, tooling

Direzione di ricerca

Start by tracing the ItemError raised while parsing the shown Solidity return declaration and inspect the return-tag parsing entry point. Add coverage for a return parameter named "$", then verify that the example is accepted and the generated documentation preserves the parameter name and description.

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

Descrizione

    /**
     * @notice Loads the storage structure from its unique slot
     * @return $ Storage struct pointer
     */
    function _loadStorage() internal pure returns (Storage storage $)

the above fails with ItemError: Expected @return tag to start with name '$'

Lingua principale
TypeScript
Stelle
460
Fork
111
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.