search

hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
232 stars 28 forks source link

Consider using underlines for italics instead of stars to be consistent with prettier's markdown formatting #142

Closed G-Rath closed 2 years ago

G-Rath commented 2 years ago

It didn't really click until today, but currently this plugin converts _words_ into *words* - personally I'm not too fussed by that, except Prettier does the opposite in it's markdown formatter (I think to make it more distinctive vs bold) and I feel like it would be good to be consistent since jsdoc comments are often treated as markdown (at least for formatting).

afaik both _words_ & *words* are allowed in JSDoc for italics, but I also could be wrong.

Happy to implement a PR (both just changing it or adding an option) if you want to see this change :)

hosseinmd commented 2 years ago

We just could apply one of that, if you think words is better, Please PR that.