jscs-dev / jscs-jsdoc

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

What was the reason for removing a period after the error message? #166

Closed gajus closed 8 years ago

gajus commented 8 years ago

https://github.com/jscs-dev/jscs-jsdoc/commit/c7684978337ff8679296923e0f971addec376e9e#diff-b42988fd48ef517b52861127d96304b8L80

In this commit you have removed a period after all the error messages. What is the reason for that?

qfox commented 8 years ago

In JSCS for some reason we don't have periods in error messages.

E.g.:

upd:

Guess because of reporting them to user.

validateIndentation: Expected indentation of 6 characters at ./lib/api.js :
    66 |                return cb(node);

Like:

<rule>: <ErrorMessage> at <file> :
  <line> | <code>...

So better to remove this period at the end.

gajus commented 8 years ago

It is somewhat ironic that an error for a rule requireDescriptionCompleteSentence is without a closing period. But if thats the convention, thats the convention.

qfox commented 8 years ago

@gajus up ↑ ;-)