search

jscs-dev / jscs-jsdoc

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

requireDescriptionCompleteSentence: Failure on multiple paragraphs in description without dot #129

Closed wooorm closed 8 years ago

wooorm commented 9 years ago

See wooorm/jscs-jsdoc-bug for a not-working example. It’s on jscs 2.0.

Also: it seems to need all the lines in the jscdoc comment to fail.

qfox commented 9 years ago

After your fix it works fine but wants a period at the end of list.

qfox commented 9 years ago 
Sentence must end with a period. at qwe.js :
     5 | * Baz:
     6 | *
     7 | * - Qux
--------^
     8 | * @param {string} x
     9 | */
wooorm commented 9 years ago

Hmm. At least there’s no failure anymore. However, it keeps complaining about non-existing problems:

First: index.js: line 7, col 0, Sentence must end with a period. (it actually means line 5, col 3, at Baz:, because when I add a dot after Qux the message stays),

If I fix that, I get index.js: line 5, col 3, You started a new line with an upper case letter but previous line does not end with a period. (which is false, and related to this rule not detecting the tick-period at 3:8-3:10).

Although this is a pretty weird example!

qfox commented 9 years ago

;-( Guess we need to rethink this rule.