Added missing documentation.

Author: gajus

.README/README.md

@@ -19,7 +19,7 @@ This table maps the rules between `eslint-plugin-jsdoc` and `jscs-jsdoc`.
 | [`check-types`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types) | [`checkTypes`](https://github.com/jscs-dev/jscs-jsdoc#checktypes) |
 | [`newline-after-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-newline-after-description) | [`requireNewlineAfterDescription`](https://github.com/jscs-dev/jscs-jsdoc#requirenewlineafterdescription) and [`disallowNewlineAfterDescription`](https://github.com/jscs-dev/jscs-jsdoc#disallownewlineafterdescription) |
 | [`require-description-complete-sentence`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description-complete-sentence) | [`requireDescriptionCompleteSentence`](https://github.com/jscs-dev/jscs-jsdoc#requiredescriptioncompletesentence) |
-| [`require-hyphen-before-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-hyphen-before-description) | [`requireHyphenBeforeDescription`](https://github.com/jscs-dev/jscs-jsdoc#requirehyphenbeforedescription) |
+| [`require-hyphen-before-param-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-hyphen-before-param-description) | [`requireHyphenBeforeDescription`](https://github.com/jscs-dev/jscs-jsdoc#requirehyphenbeforedescription) |
 | [`require-param`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param) | [`checkParamExistence`](https://github.com/jscs-dev/jscs-jsdoc#checkparamexistence) |
 | [`require-param-description`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-description) | [`requireParamDescription`](https://github.com/jscs-dev/jscs-jsdoc#requireparamdescription) |
 | [`require-param-type`](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type) | [`requireParamTypes`](https://github.com/jscs-dev/jscs-jsdoc#requireparamtypes) |
@@ -68,7 +68,7 @@ Finally, enable all of the rules that you would like to use.
         "jsdoc/check-types": 1,
         "jsdoc/newline-after-description": 1,
         "jsdoc/require-description-complete-sentence": 1,
-        "jsdoc/require-hyphen-before-description": 1,
+        "jsdoc/require-hyphen-before-param-description": 1,
         "jsdoc/require-param": 1,
         "jsdoc/require-param-description": 1,
         "jsdoc/require-param-type": 1,
@@ -105,7 +105,7 @@ Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for a
 {"gitdown": "include", "file": "./rules/check-types.md"}
 {"gitdown": "include", "file": "./rules/newline-after-description.md"}
 {"gitdown": "include", "file": "./rules/require-description-complete-sentence.md"}
-{"gitdown": "include", "file": "./rules/require-hyphen-before-description.md"}
+{"gitdown": "include", "file": "./rules/require-hyphen-before-param-description.md"}
 {"gitdown": "include", "file": "./rules/require-param.md"}
 {"gitdown": "include", "file": "./rules/require-param-description.md"}
 {"gitdown": "include", "file": "./rules/require-param-type.md"}

.README/rules/require-hyphen-before-param-description.md

@@ -0,0 +1,15 @@
+### `require-description-complete-sentence`
+
+Requires that block description and tag description are written in complete sentences, i.e.,
+
+* Description must start with an uppercase alphabetical character.
+* Paragraph must start with an uppercase alphabetical character.
+* Sentences must end with a period.
+* Every line that starts with a lowercase character must be preceded by a line ending the sentence.
+
+|||
+|---|---|
+|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
+|Tags|`param`, `returns`|
+
+<!-- assertions requireDescriptionCompleteSentence -->

package.json

@@ -26,7 +26,7 @@
     "lodash": "^4.3.0"
   },
   "scripts": {
-    "pragmatist": "node ./node_modules/.bin/pragmatist --es5",
+    "pragmatist": "pragmatist --es5",
     "lint": "npm run pragmatist lint",
     "test": "npm run pragmatist test",
     "build": "npm run pragmatist build",

src/index.js

@@ -3,7 +3,7 @@ import checkTagNames from './rules/checkTagNames';
 import checkTypes from './rules/checkTypes';
 import newlineAfterDescription from './rules/newlineAfterDescription';
 import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence';
-import requireHyphenBeforeDescription from './rules/requireHyphenBeforeDescription';
+import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription';
 import requireParam from './rules/requireParam';
 import requireParamDescription from './rules/requireParamDescription';
 import requireParamType from './rules/requireParamType';
@@ -17,7 +17,7 @@ export default {
         'check-types': checkTypes,
         'newline-after-description': newlineAfterDescription,
         'require-description-complete-sentence': requireDescriptionCompleteSentence,
-        'require-hyphen-before-description': requireHyphenBeforeDescription,
+        'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,
         'require-param': requireParam,
         'require-param-description': requireParamDescription,
         'require-param-type': requireParamType,
@@ -30,7 +30,7 @@ export default {
         'check-types': 0,
         'newline-after-description': 0,
         'require-description-complete-sentence': 0,
-        'require-hyphen-before-description': 0,
+        'require-hyphen-before-param-description': 0,
         'require-param': 0,
         'require-param-description': 0,
         'require-param-type': 0,

src/rules/requireHyphenBeforeDescription.js renamed to src/rules/requireHyphenBeforeParamDescription.js

@@ -16,7 +16,7 @@ _.forEach([
     'check-types',
     'newline-after-description',
     'require-description-complete-sentence',
-    'require-hyphen-before-description',
+    'require-hyphen-before-param-description',
     'require-param',
     'require-param-description',
     'require-param-type',