Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

etc/eslint/rules/stdlib.js

@@ -39,7 +39,7 @@ rules[ 'stdlib/empty-line-before-comment' ] = 'error';
 /**
 * Require that only allowed JSDoc tags are used.
 *
-* @name jsdoc-check-tag-names
+* @name jsdoc-tag-names
 * @memberof rules
 * @type {string}
 * @default 'error'
@@ -78,12 +78,12 @@ rules[ 'stdlib/empty-line-before-comment' ] = 'error';
 *     return x*x;
 * }
 */
-rules[ 'stdlib/jsdoc-check-tag-names' ] = 'error';
+rules[ 'stdlib/jsdoc-tag-names' ] = 'error';
 
 /**
 * Require that JSDoc descriptions start with an uppercase letter and end with a period.
 *
-* @name jsdoc-description-sentence
+* @name jsdoc-leading-description-sentence
 * @memberof rules
 * @type {string}
 * @default 'error'
@@ -120,7 +120,7 @@ rules[ 'stdlib/jsdoc-check-tag-names' ] = 'error';
 *     return Math.random();
 * }
 */
-rules[ 'stdlib/jsdoc-description-sentence' ] = 'error';
+rules[ 'stdlib/jsdoc-leading-description-sentence' ] = 'error';
 
 /**
 * Enforce that require() calls have only string literals as parameters.

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/README.md renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/README.md

@@ -1,4 +1,4 @@
-# jsdoc-description-sentence
+# jsdoc-leading-description-sentence
 
 > [ESLint rule][eslint-rules] to enforce that JSDoc descriptions start with an uppercase letter and end with a period.
 
@@ -13,7 +13,7 @@
 ## Usage
 
 ```javascript
-var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
+var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
 ```
 
 #### rule
@@ -22,7 +22,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
 
 **Bad**:
 
-<!-- eslint-disable stdlib/jsdoc-description-sentence -->
+<!-- eslint-disable stdlib/jsdoc-leading-description-sentence -->
 
 ```javascript
 /**
@@ -66,7 +66,7 @@ function rand() {
 
 ```javascript
 var Linter = require( 'eslint' ).Linter;
-var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
+var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
 
 var linter = new Linter();
 var result;
@@ -88,18 +88,18 @@ code = [
     '}'
 ].join( '\n' );
 
-linter.defineRule( 'jsdoc-description-sentence', rule );
+linter.defineRule( 'jsdoc-leading-description-sentence', rule );
 
 result = linter.verify( code, {
     'rules': {
-        'jsdoc-description-sentence': 'error'
+        'jsdoc-leading-description-sentence': 'error'
     }
 });
 console.log( result );
 /* =>
     [
         {
-            'ruleId': 'jsdoc-description-sentence',
+            'ruleId': 'jsdoc-leading-description-sentence',
             'severity': 2,
             'message': 'Description must start with an uppercase letter and end with a period',
             'line': 1,

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/examples/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/examples/index.js

@@ -23,18 +23,18 @@ code = [
 	'}'
 ].join( '\n' );
 
-linter.defineRule( 'jsdoc-description-sentence', rule );
+linter.defineRule( 'jsdoc-leading-description-sentence', rule );
 
 result = linter.verify( code, {
 	'rules': {
-		'jsdoc-description-sentence': 'error'
+		'jsdoc-leading-description-sentence': 'error'
 	}
 });
 console.log( result );
 /* =>
 	[
 		{
-			'ruleId': 'jsdoc-description-sentence',
+			'ruleId': 'jsdoc-leading-description-sentence',
 			'severity': 2,
 			'message': 'Description must start with an uppercase letter and end with a period',
 			'line': 1,

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-check-tag-names/lib/get_jsdoc_comment.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/lib/get_jsdoc_comment.js

@@ -3,10 +3,10 @@
 /**
 * ESLint rule to enforce that JSDoc descriptions start with an uppercase letter and end with a period.
 *
-* @module @stdlib/_tools/eslint/rules/jsdoc-description-sentence
+* @module @stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence
 *
 * @example
-* var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-description-sentence' );
+* var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence' );
 *
 * console.log( rule );
 */

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-description-sentence/lib/index.js renamed to lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence/lib/index.js

@@ -1,5 +1,5 @@
 {
-  "name": "@stdlib/_tools/eslint/rules/jsdoc-description-sentence",
+  "name": "@stdlib/_tools/eslint/rules/jsdoc-leading-description-sentence",
   "version": "0.0.0",
   "description": "ESLint rule to enforce that JSDoc descriptions start with an uppercase letter and end with a period.",
   "license": "MIT AND Apache-2.0",