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
{{ message }}
This repository was archived by the owner on Mar 23, 2024. It is now read-only.
The new requireHyphenBeforeDescription option is great, but it should only apply to inline descriptions. If a description is on the next line (usually because it's a long one), then no hyphen should be required.
Example:
/** * This function does foo to bar. * * @param {string} bar * This is a really long description of the "bar" parameter. In fact, the description * is so long that it spans multiple lines. */functionfoo(bar){
Currently, in order to make this check pass, I have to add a hyphen, like this (which looks weird):
/** * This function does foo to bar. * * @param {string} bar * - This is a really long description of the "bar" parameter. In fact, the description * is so long that it spans multiple lines. */functionfoo(bar){
The new
requireHyphenBeforeDescriptionoption is great, but it should only apply to inline descriptions. If a description is on the next line (usually because it's a long one), then no hyphen should be required.Example:
Currently, in order to make this check pass, I have to add a hyphen, like this (which looks weird):