Docs: fix grammar for couple of rules

Fixes #158
Closes gh-161

Author: Alexej Yaroshevich

README.md

@@ -73,13 +73,15 @@ To use plugin you should add these lines to configuration file `.jscsrc`:
 
 ### checkAnnotations
 
-Ensures tag names are valid
+Checks tag names are valid.
 
 There are 3 presets for `Closure Compiler`, `JSDoc3` and `JSDuck5`.
 
-By default it allows any tag of mixed set. You can pass `Object` to select preset with `preset` field and add custom tags with `extra` field.
+By default it allows any tag from any preset. You can pass `Object`
+to select preset with `preset` field and add custom tags with `extra` field.
 
-Type: `Boolean` or `String` or `{"preset": String, "extra": Object}` (see [tag values](#user-content-tag-values))
+Type: `Boolean` or `String` or `{"preset": String, "extra": Object}`
+(see [tag values](#user-content-tag-values)).
 
 Values: `true`, `"closurecompiler"`, `"jsdoc3"`, `"jsduck5"`, `Object`
 
@@ -152,7 +154,7 @@ function _f() {}
 
 ### checkParamExistence
 
-Ensures all parameters are documented.
+Checks all parameters are documented.
 
 Type: `Boolean`
 
@@ -197,7 +199,7 @@ function _f ( message ) {
 
 ### checkParamNames
 
-Ensures param names in jsdoc and in function declaration are equal
+Checks param names in jsdoc and in function declaration are equal.
 
 Type: `Boolean`
 
@@ -235,7 +237,7 @@ function method(message) {}
 
 ### requireParamTypes
 
-Ensures params in jsdoc contains type
+Checks params in jsdoc contains type.
 
 Type: `Boolean`
 
@@ -271,7 +273,7 @@ function method() {}
 
 ### checkRedundantParams
 
-Reports redundant params in jsdoc
+Reports redundant params in jsdoc.
 
 Type: `Boolean`
 
@@ -307,7 +309,7 @@ function method() {}
 
 ### checkReturnTypes
 
-Reports discrepancies between the claimed in jsdoc and actual type if both exist (code scan)
+Checks for differences between the jsdoc and actual return types if both exist.
 
 Type: `Boolean`
 
@@ -350,7 +352,7 @@ function method(f) {
 
 ### checkRedundantReturns
 
-Report statements for functions with no return
+Report statements for functions without return.
 
 Type: `Boolean`
 
@@ -390,7 +392,7 @@ function f() {
 
 ### requireReturnTypes
 
-Ensures returns in jsdoc contains type
+Checks returns in jsdoc contains type
 
 Type: `Boolean`
 
@@ -431,11 +433,13 @@ function method() {}
 
 ### checkTypes
 
-Reports invalid types for bunch of tags
+Reports invalid types for bunch of tags.
 
-In `strictNativeCase` mode ensures that case of natives is the same as in this list: `boolean`, `number`, `string`, `Object`, `Array`, `Date`, `RegExp`.
+The `strictNativeCase` mode checks that case of natives is the same as in this
+list: `boolean`, `number`, `string`, `Object`, `Array`, `Date`, `RegExp`.
 
-In `capitalizedNativeCase` mode ensures that first letter in all native types and primitives is uppercased except the case with `function` in google closure format: `{function(...)}`
+The `capitalizedNativeCase` mode checks that the first letter in all native
+types and primitives is uppercased except the case with `function` in google closure format: `{function(...)}`
 
 Type: `Boolean` or `String`
 
@@ -503,7 +507,7 @@ var x = 1;
 
 ### checkRedundantAccess
 
-Reports redundant access declarations
+Reports redundant access declarations.
 
 Type: `Boolean` or `String`
 
@@ -555,9 +559,11 @@ function _f() {}
 
 ### leadingUnderscoreAccess
 
-Ensures access declaration is set for `_underscored` function names
+Checks access declaration is set for `_underscored` function names
 
-Ignores a bunch of popular identifiers: `__filename`, `__dirname`, `__proto__`, `__defineGetter__`, `super_`, `__constructor`, etc.
+Ignores a bunch of popular identifiers:
+`__filename`, `__dirname`, `__proto__`, `__defineGetter__`, `super_`,
+`__constructor`, etc.
 
 Type: `Boolean` or `String`
 
@@ -595,7 +601,7 @@ function _e() {}
 
 ### enforceExistence
 
-Ensures jsdoc block exist
+Checks jsdoc block exists.
 
 Type: `Boolean`, `String` or `Object`
 
@@ -606,7 +612,8 @@ Values:
   - `"allExcept"` array of exceptions:
     - `"expressions"` skip expression functions
     - `"exports"` skip `module.exports = function () {};`
-    - `"paramless-procedures"` functions without parameters and with empty return statements will be skipped
+    - `"paramless-procedures"` functions without parameters and with empty
+      return statements will be skipped
 
 Context: `functions`
 
@@ -634,7 +641,7 @@ function _g() {}
 
 ### requireHyphenBeforeDescription
 
-Ensures a param description has a hyphen before it (checks for `- `)
+Checks a param description has a hyphen before it (checks for `- `).
 
 Type: `Boolean`
 
@@ -671,7 +678,7 @@ function method() {}
 
 ### requireNewlineAfterDescription
 
-Ensures a doc comment description has padding newline
+Checks a doc comment description has padding newline.
 
 Type: `Boolean`
 
@@ -721,7 +728,7 @@ function method() {}
 
 ### disallowNewlineAfterDescription
 
-Ensures a doc comment description has no padding newlines
+Checks a doc comment description has no padding newlines.
 
 Type: `Boolean`
 
@@ -771,9 +778,10 @@ function method() {}
 
 ### requireDescriptionCompleteSentence
 
-Ensures a doc comment description is a complete sentence.
+Checks a doc comment description is a complete sentence.
 
-A complete sentence is defined as starting with an upper case letter and ending with a period.
+A complete sentence is defined as starting with an upper case letter and ending
+with a period.
 
 Type: `Boolean`
 
@@ -854,7 +862,7 @@ function method() {}
 
 ### requireParamDescription
 
-Ensures a param description exists.
+Checks a param description exists.
 
 Type: `Boolean`
 
@@ -901,7 +909,7 @@ function method(arg) {}
 
 ### requireReturnDescription
 
-Ensures a return description exists.
+Checks a return description exists.
 
 Type: `Boolean`
 

lib/rules/validate-jsdoc/require-description-complete-sentence.js

@@ -5,7 +5,7 @@ module.exports.options = {
 };
 
 /**
- * Ensures that every sentence starts with an upper case letter.
+ * Checks that every sentence starts with an upper case letter.
  *
  * This matches when a new line or start of a blank line
  * does not start with an upper case letter.
@@ -18,7 +18,7 @@ var START_DESCRIPTION = /^[*\s]*[a-z]/g;
 var RE_END_DESCRIPTION = /\n/g;
 
 /**
- * Ensures next lines with uppercase letters have periods.
+ * Checks next lines with uppercase letters have periods.
  *
  * This checks for the existance of a new line that starts with an
  * upper case letter where the previous line does not have a period
@@ -27,10 +27,10 @@ var RE_END_DESCRIPTION = /\n/g;
 var RE_NEW_LINE_UPPERCASE = /\w(?![.])(\W)*\n\W*[A-Z]/g;
 
 /**
- * Ensures that a sentence followed by a blank line has a period
+ * Checks that a sentence followed by a blank line has a period
  *
  * If the above line did not have a period this would match.
- * this also ensures that the last sentence in the description ends with a period.
+ * this also checks that the last sentence in the description ends with a period.
  *
  * This also matches white-space followed by a period.
  */