castwide / vscode-solargraph

A Visual Studio Code extension for Solargraph.
Other
425 stars 23 forks source link

Line breaks in Ruby source doc comments #160

Open derkallevombau opened 4 years ago

derkallevombau commented 4 years ago

It would be great if one of these worked generally, preferably \<br>, but \ would do it as well.

However, thank you for this awesome extension!

castwide commented 4 years ago

I'm not sure if this feature will be supported or not. The typical use case for @param text is a brief description, not more than 1 or 2 lines. If you need more than that, it probably belongs in the method documentation body.