You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some of us (🤚🏻) are used to wrapping code at 80 characters and apply this line wrapping to JSDocs as well.
Unfortunately the JSDoc interpreter part of the language server renders line breaks literally, and may cause params, properties, etc. to not get rendered appropriately.
For instance, notice how the @returns line is missing an em-dash:
This happens because @returns is wrapped at 80 characters. However, if we don't do that, then we get this:
It would be nice if we could figure out some way of enforcing no excessive line breaks in JSDocs. This would likely have to be a custom rule due to line breaks being necessary to separate paragraphs, etc.
The text was updated successfully, but these errors were encountered:
Counterargument to adding this rule: VSCode's TypeScript integration does not seem to wrap JSDoc blocks in popovers. Wrapped descriptions, at the very least, are easier to read than unwrapped descriptions. Therefore while enforcing that JSDoc blocks are unwrapped would make them look consistent, it would also reduce readability.
Some of us (🤚🏻) are used to wrapping code at 80 characters and apply this line wrapping to JSDocs as well.
Unfortunately the JSDoc interpreter part of the language server renders line breaks literally, and may cause params, properties, etc. to not get rendered appropriately.
For instance, notice how the
@returns
line is missing an em-dash:This happens because
@returns
is wrapped at 80 characters. However, if we don't do that, then we get this:It would be nice if we could figure out some way of enforcing no excessive line breaks in JSDocs. This would likely have to be a custom rule due to line breaks being necessary to separate paragraphs, etc.
The text was updated successfully, but these errors were encountered: