Multi-paragraph dev comment formatting issue
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 48/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Stack tecnologico
- handlebars
- Ambito
- documentation
Direzione di ricerca
Start in themes/markdown/common.hbs and inspect how natspec.dev is formatted for generated Markdown. Reproduce the issue with a multi-paragraph dev comment, update the formatting there, and verify that both single- and multi-paragraph comments render as intended.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Single paragraph dev comments are shown as italic because of using _ before and after it.
_ does not work for multi-paragraph text properly, so instead it shows up as _
I encountered this, and I saw someone has raised this two months ago on stackexchange:
https://ethereum.stackexchange.com/questions/142917/how-to-get-solidity-docgen-to-properly-render-multi-paragraph-devs
An easy fix would be using <em> ... </em> instead of _ in themes/markdown/common.hbs
replacing _{{{natspec.dev}}}_ with <em>{{{natspec.dev}}}</em>
Can someone please action this if it makes sense?
- 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 ·
-
Use docgen in the browserAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
OpenZeppelin/solidity-docgen#437 · 4 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
OpenZeppelin/solidity-docgen#433 · 2 commenti ·
Tutte le issue di OpenZeppelin/solidity-docgen
Issue simili
-
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
-
good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
dataforgoodfr/mediterranean-rescue#91 ·
I maintainer di solito rispondono entro 1 giorno
-
transformer-directives: `@apply` drops a utility whose CSS is a substring of an earlier one'sForse già presa Una pull request collegata a questa issue è aperta o già unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
-
Add: KRT TVApertaapproved check:passed streams:add
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
iptv-org/iptv#58647 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
milind-soni/OpenMausBot#5829 ·
I maintainer di solito rispondono entro 1 giorno