Incorrect underscore when using blank lines

Aperta
  • Qualcosa non va?
#454 0 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
typescript
Ambito
documentation

Direzione di ricerca

Reproduce the issue with the NatSpec example and inspect the Markdown generation path that handles blank lines and underscores. The fix is done when the generated .md preserves the paragraph without wrapping all content in underscores and remains valid Markdown.

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

Descrizione

When using empty lines in the NatSpec like the following:

    /**
     * @dev Displayed when the amount of {ISwap-Asset} has a length of zero.
     *
     * NOTE: The `biding` or `asking` array must not be empty to avoid mistakes
     * when creating a swap. Assuming one side of the swap is empty, the
     * correct approach should be the usage of {transferFrom} and we reinforce
     * this behavior by requiring the length of the array to be bigger than zero.
     */
    error InvalidAssetsLength();

The generation will try to embrace all content in underscore (_) like so:

   ``solidity
   error InvalidAssetsLength()
   ``

   \_Displayed when the amount of {ISwap-Asset} has a length of zero.

   NOTE: The `biding` or `asking` array must not be empty to avoid mistakes
   when creating a swap. Assuming one side of the swap is empty, the
   correct approach should be the usage of {transferFrom} and we reinforce
   this behavior by requiring the length of the array to be bigger than zero.\_

But the .md will consider it invalid when generating the output, not processing the underscore correctly, resulting in:
image

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.