docs: update wording

Planeshifter · Planeshifter · commit 3db37f0ae58d · 2023-07-28T23:45:04.000-04:00
diff --git a/etc/eslint/rules/stdlib.js b/etc/eslint/rules/stdlib.js
@@ -3993,7 +3993,7 @@ rules[ 'stdlib/new-cap-regexp' ] = 'error';
 rules[ 'stdlib/no-dynamic-require' ] = 'error';
 
 /**
-* Require that comments are not empty.
+* Disallow empty comments.
 *
 * @name no-empty-comments
 * @memberof rules
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # No Space-Aligned Asterisks
 
-> [ESLint rule][eslint-rules] to prevent prevent space-aligned asterisks for JSDoc comments.
+> [ESLint rule][eslint-rules] to disallow space-aligned asterisks for JSDoc comments.
 
 <section class="intro">
 
@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisk
 
 #### rule
 
-[ESLint rule][eslint-rules] to prevent space-aligned asterisks for JSDoc comments.
+[ESLint rule][eslint-rules] to disallow space-aligned asterisks for JSDoc comments.
 
 **Bad**:
 
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks/package.json b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks",
   "version": "0.0.0",
-  "description": "ESLint rule to prevent space-aligned asterisks for JSDoc comments.",
+  "description": "ESLint rule to disallow space-aligned asterisks for JSDoc comments.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # No Empty Comments
 
-> [ESLint rule][eslint-rules] to prevent empty comments.
+> [ESLint rule][eslint-rules] to disallow empty comments.
 
 <section class="intro">
 
@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/no-empty-comments' );
 
 #### rule
 
-[ESLint rule][eslint-rules] to prevent empty comments. Comments are considered empty if they contain only whitespace characters.
+[ESLint rule][eslint-rules] to disallow empty comments.
 
 **Bad**:
 
@@ -70,6 +70,16 @@ function square( x ) {
 
 <!-- /.usage -->
 
+<section class="notes">
+
+## Notes
+
+-   Comments are considered empty if they contain only whitespace characters.
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ## Examples
@@ -88,8 +98,8 @@ code = [
     'function pow2( x ) {',
     '  var out;',
     '',
-    '  // square the number:',
-    '  out = x*x; // x^2',
+    '  /* */',
+    '  out = x*x; //',
     '  return out;',
     '}'
 ].join( '\n' );
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/lib/index.js b/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/lib/index.js
@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* ESLint rule to ensure that there are no empty comments.
+* ESLint rule to disallow empty comments.
 *
 * @module @stdlib/_tools/eslint/rules/no-empty-comments
 *
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/lib/main.js b/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/lib/main.js
@@ -67,7 +67,7 @@ function main(context) {
 	}
 
 	/**
-	* Checks if there are empty comments in the code.
+	* Checks for empty code comments.
 	*
 	* @private
 	* @param {ASTNode} node - program to examine
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/package.json b/lib/node_modules/@stdlib/_tools/eslint/rules/no-empty-comments/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/_tools/eslint/rules/no-empty-comments",
   "version": "0.0.0",
-  "description": "ESLint rule to enforce that comments start with an uppercase letter.",
+  "description": "ESLint rule to disallow empty comments",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

Original file line number	Diff line number	Diff line change
`@@ -3993,7 +3993,7 @@ rules[ 'stdlib/new-cap-regexp' ] = 'error';`
`3993`	`3993`	`rules[ 'stdlib/no-dynamic-require' ] = 'error';`
`3994`	`3994`
`3995`	`3995`	`/**`
`3996`		`-* Require that comments are not empty.`
	`3996`	`+* Disallow empty comments.`
`3997`	`3997`	`*`
`3998`	`3998`	`* @name no-empty-comments`
`3999`	`3999`	`* @memberof rules`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks",`
`3`	`3`	`"version": "0.0.0",`
`4`		`- "description": "ESLint rule to prevent space-aligned asterisks for JSDoc comments.",`
	`4`	`+ "description": "ESLint rule to disallow space-aligned asterisks for JSDoc comments.",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"author": {`
`7`	`7`	`"name": "The Stdlib Authors",`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`'use strict';`
`20`	`20`
`21`	`21`	`/**`
`22`		`-* ESLint rule to ensure that there are no empty comments.`
	`22`	`+* ESLint rule to disallow empty comments.`
`23`	`23`	`*`
`24`	`24`	`* @module @stdlib/_tools/eslint/rules/no-empty-comments`
`25`	`25`	`*`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ function main(context) {`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * Checks if there are empty comments in the code.`
	`70`	`+ * Checks for empty code comments.`
`71`	`71`	`*`
`72`	`72`	`* @private`
`73`	`73`	`* @param {ASTNode} node - program to examine`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@stdlib/_tools/eslint/rules/no-empty-comments",`
`3`	`3`	`"version": "0.0.0",`
`4`		`- "description": "ESLint rule to enforce that comments start with an uppercase letter.",`
	`4`	`+ "description": "ESLint rule to disallow empty comments",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"author": {`
`7`	`7`	`"name": "The Stdlib Authors",`