search

jscs-dev / jscs-jsdoc

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

added new rule: require-description-complete-sentence #109

Closed dtracers closed 9 years ago

dtracers commented 9 years ago

Added a new rule that requires the description to be a complete sentence.

A complete sentence starts with an upper case letter and ends with a period

qfox commented 9 years ago

Nice work here ;-) Thanks!

What you think about this rules API? Should we document it? Is it comfortable for you?

dtracers commented 9 years ago

For what I was doing it was pretty easy because I just copied an existing rule from an existing pull request.

If I had not done that I would have been pretty lost. But I did not actually go and look for documentation of it. I copied off of https://github.com/jscs-dev/jscs-jsdoc/pull/99/files.

I think in your documentation for making rules you should actually choose a pull request that shows all the parts needed for a rule.

I would actually use this one: https://github.com/jscs-dev/jscs-jsdoc/pull/98/files

And then in this one pull request add extensive documentation of what each part means. Explain what the tags mean and how they look in a jsdoc. Explain the scoping and the different options. Add documentation explaining what node, tag, and err is.

And I feel that would make it easier than just a bunch of text. But that is just me! :+1:

dtracers commented 9 years ago

Changed how the rules work so it will require another review.

Also build failed due to ssl error?

coveralls commented 9 years ago

Coverage Status

Coverage increased (+0.36%) to 95.77% when pulling b8e26d63487da6a6a05ea279cc35d3205bae8437 on dtracers:master into a34608a22b215debd8165dbaa2eb82f5c1bff060 on jscs-dev:master.

qfox commented 9 years ago

Restarted job and it helps ;-\

I'll look into it tomorrow, thanks for you hard work here ;-)

dtracers commented 9 years ago

Okay thank you! On Jun 8, 2015 8:03 PM, "Alexej Yaroshevich" notifications@github.com wrote:

Restarted job and it helps ;-\

I'll look into it tomorrow, thanks for you hard work here ;-)

— Reply to this email directly or view it on GitHub https://github.com/jscs-dev/jscs-jsdoc/pull/109#issuecomment-110197452.