chore: minor clean-up

Planeshifter · Planeshifter · commit 8478937138b9 · 2025-06-23T20:47:41.000-05:00
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-heading-style/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-heading-style/README.md
@@ -151,7 +151,7 @@ console.log( result );
             'line': 4,
             'column': 3,
             'nodeType': null,
-            'source': '* ## Boop ##',
+            'source': '* ## Beep ##',
             'endLine': 19,
             'endColumn': 3
         },
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-heading-style/examples/index.js b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-heading-style/examples/index.js
@@ -70,7 +70,6 @@ console.log( result );
 			'line': 4,
 			'column': 3,
 			'nodeType': null,
-			'source': '* ## Boop ##',
 			'endLine': 19,
 			'endColumn': 3
 		},
@@ -81,7 +80,6 @@ console.log( result );
 			'line': 8,
 			'column': 3,
 			'nodeType': null,
-			'source': '* Boop',
 			'endLine': 19,
 			'endColumn': 3
 		}
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-multiple-toplevel-headings/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-multiple-toplevel-headings/README.md
@@ -148,7 +148,7 @@ console.log( result );
 /* =>
     [
         {
-            'ruleId': 'jsdoc-no-multiple-toplevel-heading',
+            'ruleId': 'jsdoc-no-multiple-toplevel-headings',
             'severity': 2,
             'message': 'Don’t use multiple top level headings (5:1)',
             'line': 6,
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
@@ -128,10 +128,10 @@ console.log( result );
             'severity': 2,
             'message': 'JSDoc comments should not have space-aligned asterisks',
             'line': 1,
-            'column':1,
+            'column': 1,
             'nodeType': null,
             'endLine': 10,
-            'endColumn': 4
+            'endColumn': 4,
             'fix': {
                 'range': [...],
                 'text': '...'
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-table-indentation/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-table-indentation/README.md
@@ -147,7 +147,7 @@ console.log( result );
         {
             'ruleId': 'jsdoc-no-table-indentation',
             'severity': 2,
-            'message: 'Do not indent table rows',
+            'message': 'Do not indent table rows',
             'line': 6,
             'column': 3,
             'nodeType': null,
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references/README.md
@@ -132,7 +132,6 @@ console.log( result );
             'line': 2,
             'column': 8,
             'nodeType': null,
-            'source': '* Beep [boop][boop].',
             'endLine': 10,
             'endColumn': 3
         }
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references/examples/index.js b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references/examples/index.js
@@ -61,7 +61,6 @@ console.log( result );
 			'line': 2,
 			'column': 8,
 			'nodeType': null,
-			'source': '* Beep [boop][boop].',
 			'endLine': 10,
 			'endColumn': 3
 		}
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/no-dynamic-exports/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/no-dynamic-exports/README.md
@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/no-dynamic-exports' );
 
 #### rule
 
-[ESLint rule][eslint-rules] enforcing only statically analyzable values are exported. Statically analyable values include function expressions, variables, and string and number literals. The rule validates both Node.js `module.exports` and ECMAScript 6 default exports. 
+[ESLint rule][eslint-rules] enforcing only statically analyzable values are exported. Statically analyzable values include function expressions, variables, and string and number literals. The rule validates both Node.js `module.exports` and ECMAScript 6 default exports. 
 
 **Bad**:
 
diff --git a/lib/node_modules/@stdlib/_tools/eslint/utils/find-jsdoc/README.md b/lib/node_modules/@stdlib/_tools/eslint/utils/find-jsdoc/README.md
@@ -79,7 +79,7 @@ code = [
     '/**',
     '* Squares a number.',
     '* ',
-    '* @params {number} x - input number',
+    '* @param {number} x - input number',
     '* @returns {number} x squared',
     '*',
     '* @examples',
diff --git a/lib/node_modules/@stdlib/_tools/github/following/README.md b/lib/node_modules/@stdlib/_tools/github/following/README.md
@@ -207,7 +207,7 @@ function clbk( error, results, info ) {
 ### Usage
 
 ```bash
-Usage: ghfollowing [options] 
+Usage: ghfollowing [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/get/README.md b/lib/node_modules/@stdlib/_tools/github/get/README.md
@@ -341,7 +341,7 @@ function onResponse( error, data, info ) {
 ### Usage
 
 ```text
-Usage: ghget [options] 
+Usage: ghget [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/rank-followers/README.md b/lib/node_modules/@stdlib/_tools/github/rank-followers/README.md
@@ -240,7 +240,7 @@ function clbk( error, results, info ) {
 ### Usage
 
 ```bash
-Usage: ghrankfollowers [options] 
+Usage: ghrankfollowers [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/rank-followers/docs/usage.txt b/lib/node_modules/@stdlib/_tools/github/rank-followers/docs/usage.txt
@@ -1,5 +1,5 @@
 
-Usage: ghrankfollowers [options] 
+Usage: ghrankfollowers [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/starred/README.md b/lib/node_modules/@stdlib/_tools/github/starred/README.md
@@ -209,7 +209,7 @@ function clbk( error, results, info ) {
 ### Usage
 
 ```bash
-Usage: ghstarred [options] 
+Usage: ghstarred [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/starred/docs/usage.txt b/lib/node_modules/@stdlib/_tools/github/starred/docs/usage.txt
@@ -1,5 +1,5 @@
 
-Usage: ghstarred [options] 
+Usage: ghstarred [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/subscriptions/docs/usage.txt b/lib/node_modules/@stdlib/_tools/github/subscriptions/docs/usage.txt
@@ -1,5 +1,5 @@
 
-Usage: ghwatching [options] 
+Usage: ghwatching [options]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/markdown/to-html/README.md b/lib/node_modules/@stdlib/_tools/markdown/to-html/README.md
@@ -45,7 +45,7 @@ var toHTML = require( '@stdlib/_tools/markdown/to-html' );
 Converts a Markdown `string` or [`Buffer`][node-buffer] to HTML.
 
 ```javascript
-toHtml( '# Beep\n\n> Boop!', done );
+toHTML( '# Beep\n\n> Boop!', done );
 
 function done( error, html ) {
     if ( error ) {
@@ -59,7 +59,7 @@ function done( error, html ) {
 By default, the plugin resolves package identifiers to `/docs/api/develop/` documentation paths. To specify an alternative base path, set the `base` option.
 
 ```javascript
-toHtml( '[@stdlib/boop](https://github.com/stdlib-js/stdlib)', '/docs/api/v0.0.90/', done );
+toHTML( '[@stdlib/boop](https://github.com/stdlib-js/stdlib)', '/docs/api/v0.0.90/', done );
 
 function done( error, html ) {
     if ( error ) {
diff --git a/lib/node_modules/@stdlib/_tools/pkgs/tree/README.md b/lib/node_modules/@stdlib/_tools/pkgs/tree/README.md
@@ -167,7 +167,7 @@ function onTree( error, tree ) {
 ### Usage
 
 ```text
-Usage: stdlib-pkg-tree [options] [dir]
+Usage: stdlib-pkg-tree [options] [<dir>]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/pkgs/tree/docs/usage.txt b/lib/node_modules/@stdlib/_tools/pkgs/tree/docs/usage.txt
@@ -1,5 +1,5 @@
 
-Usage: stdlib-pkg-tree [options] [dir]
+Usage: stdlib-pkg-tree [options] [<dir>]
 
 Options:
 
diff --git a/lib/node_modules/@stdlib/_tools/repl-txt/rules/section-heading-style/lib/main.js b/lib/node_modules/@stdlib/_tools/repl-txt/rules/section-heading-style/lib/main.js
@@ -31,7 +31,7 @@ var RE_HYPHEN = /-/g;
 // FUNCTIONS //
 
 /**
-* Counts the number of a hyphens (`-`) in a string.
+* Counts the number of hyphens (`-`) in a string.
 *
 * @private
 * @param {string} str - input string
diff --git a/lib/node_modules/@stdlib/_tools/repl-txt/rules/tag-typedef-typos/lib/main.js b/lib/node_modules/@stdlib/_tools/repl-txt/rules/tag-typedef-typos/lib/main.js
@@ -30,7 +30,7 @@ var DEFAULTS = require( './defaults.json' );
 
 // VARIABLES //
 
-var THRESHOLD = 2; // assume that a minimal edit distance of less than or equal to one signals a typo and not an unknown type
+var THRESHOLD = 2; // assume that a minimal edit distance of less than or equal to two signals a typo and not an unknown type
 
 
 // MAIN //
diff --git a/lib/node_modules/@stdlib/_tools/repl-txt/wrap-desc/lib/main.js b/lib/node_modules/@stdlib/_tools/repl-txt/wrap-desc/lib/main.js
@@ -39,7 +39,9 @@ var TAB = '    ';
 * @returns {string} wrapped text
 *
 * @example
-* // TODO
+* var txt = 'This is a very long description that should be wrapped to fit within the specified width constraints for proper formatting.';
+* var out = wrap( txt );
+* console.log( out );
 */
 function wrap( txt ) {
 	var lines;
diff --git a/lib/node_modules/@stdlib/_tools/static-analysis/js/lloc-file-list/README.md b/lib/node_modules/@stdlib/_tools/static-analysis/js/lloc-file-list/README.md
@@ -91,7 +91,7 @@ Synchronously calculates [logical lines of code][@stdlib/_tools/static-analysis/
 ```javascript
 var files = [ './beep.js', './boop.js' ];
 
-var results = analyze( files );
+var results = analyze.sync( files );
 if ( results instanceof Error ) {
     throw results;
 }
diff --git a/lib/node_modules/@stdlib/_tools/static-analysis/js/sloc-glob/README.md b/lib/node_modules/@stdlib/_tools/static-analysis/js/sloc-glob/README.md
@@ -148,7 +148,7 @@ function clbk( error, results ) {
 Synchronously calculates [source lines of code][@stdlib/_tools/static-analysis/js/incr/sloc] (SLOC) on a file glob.
 
 ```javascript
-var results = analyze();
+var results = analyze.sync();
 if ( results instanceof Error ) {
     throw results;
 }
diff --git a/lib/node_modules/@stdlib/_tools/static-analysis/js/summarize-file-list/README.md b/lib/node_modules/@stdlib/_tools/static-analysis/js/summarize-file-list/README.md
@@ -88,7 +88,7 @@ Synchronously performs a static [summary analysis][@stdlib/_tools/static-analysi
 ```javascript
 var files = [ './beep.js', './boop.js' ];
 
-var results = analyze( files );
+var results = analyze.sync( files );
 if ( results instanceof Error ) {
     throw results;
 }
diff --git a/lib/node_modules/@stdlib/_tools/static-analysis/js/summarize-glob/README.md b/lib/node_modules/@stdlib/_tools/static-analysis/js/summarize-glob/README.md
@@ -148,7 +148,7 @@ function clbk( error, results ) {
 Synchronously performs a static [summary analysis][@stdlib/_tools/static-analysis/js/incr/program-summary] on a file glob.
 
 ```javascript
-var results = analyze();
+var results = analyze.sync();
 if ( results instanceof Error ) {
     throw results;
 }

Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ console.log( result );`
`148`	`148`	`/* =>`
`149`	`149`	`[`
`150`	`150`	`{`
`151`		`- 'ruleId': 'jsdoc-no-multiple-toplevel-heading',`
	`151`	`+ 'ruleId': 'jsdoc-no-multiple-toplevel-headings',`
`152`	`152`	`'severity': 2,`
`153`	`153`	`'message': 'Don’t use multiple top level headings (5:1)',`
`154`	`154`	`'line': 6,`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ console.log( result );`
`147`	`147`	`{`
`148`	`148`	`'ruleId': 'jsdoc-no-table-indentation',`
`149`	`149`	`'severity': 2,`
`150`		`- 'message: 'Do not indent table rows',`
	`150`	`+ 'message': 'Do not indent table rows',`
`151`	`151`	`'line': 6,`
`152`	`152`	`'column': 3,`
`153`	`153`	`'nodeType': null,`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,6 @@ console.log( result );`
`132`	`132`	`'line': 2,`
`133`	`133`	`'column': 8,`
`134`	`134`	`'nodeType': null,`
`135`		`- 'source': '* Beep [boop][boop].',`
`136`	`135`	`'endLine': 10,`
`137`	`136`	`'endColumn': 3`
`138`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,6 @@ console.log( result );`
`61`	`61`	`'line': 2,`
`62`	`62`	`'column': 8,`
`63`	`63`	`'nodeType': null,`
`64`		`- 'source': '* Beep [boop][boop].',`
`65`	`64`	`'endLine': 10,`
`66`	`65`	`'endColumn': 3`
`67`	`66`	`}`