Multi-paragraph dev comment formatting issue

[0xMohandes]

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?

[TSxo]

This is an ongoing issue for me too - this change would be welcome.

[frangio]

The suggestion doesn't really work because <em> elements are not permitted to have paragraphs inside them.

It's not really possible to do this generically with markdown. You can solve this in your project by copying common.hbs into a docgen-templates directory and adding docgen: { templates: 'docgen-templates' } in your Hardhat config, then customizing the part of the template that isn't working for you.