jscs-dev / jscs-jsdoc

JsDoc validation rules for jscs
MIT License
99 stars 35 forks source link

requireDescriptionCompleteSentence invalid example in the documentation #153

Closed gajus closed 8 years ago

gajus commented 8 years ago
/**
 * Description
 * On multiple lines.
 *
 * @param {String} - message
 */
function method() {}

Is included as valid, but it fails (as expected) with an error:

You started a new line with an upper case letter but previous line does not end with a period.