docs: update links and fix various documentation issues

Planeshifter · Planeshifter · commit 69e10261dd91 · 2025-06-23T20:47:41.000-05:00
diff --git a/lib/node_modules/@stdlib/_tools/bib/citation-reference/lib/async.js b/lib/node_modules/@stdlib/_tools/bib/citation-reference/lib/async.js
@@ -48,7 +48,7 @@ var debug = logger( 'to-reference:async' );
 // MAIN //
 
 /**
-* Asynchronously return a reference corresponding to a citation identifier.
+* Asynchronously returns a reference corresponding to a citation identifier.
 *
 * @param {string} id - citation identifier
 * @param {Options} [options] - function options
diff --git a/lib/node_modules/@stdlib/_tools/bib/citation-reference/lib/sync.js b/lib/node_modules/@stdlib/_tools/bib/citation-reference/lib/sync.js
@@ -47,12 +47,15 @@ var debug = logger( 'to-reference:sync' );
 // MAIN //
 
 /**
-* Synchronously return a reference corresponding to a citation identifier.
+* Synchronously returns a reference corresponding to a citation identifier.
 *
 * @param {string} id - citation identifier
 * @param {Options} [options] - function options
 * @param {string} [options.database] - path to a bibliography database file
 * @param {string} [options.csl] - path to a Citation Style Language (CSL) file
+* @throws {TypeError} first argument must be a string
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
 * @returns {string} reference
 *
 * @example
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-tabs/package.json b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-no-tabs/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/_tools/eslint/rules/jsdoc-no-tabs",
   "version": "0.0.0",
-  "description": "ESLint rule forbidding the use of tabs.",
+  "description": "ESLint rule forbidding the use of tabs in JSDoc comments.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
diff --git a/lib/node_modules/@stdlib/_tools/github/following/lib/index.js b/lib/node_modules/@stdlib/_tools/github/following/lib/index.js
@@ -43,7 +43,7 @@
 *         throw new Error( error.message );
 *     }
 *     console.log( JSON.stringify( results ) );
-*     // returns <user_data>
+*     // => <user_data>
 * }
 */
 
diff --git a/lib/node_modules/@stdlib/_tools/pkgs/repl-help/README.md b/lib/node_modules/@stdlib/_tools/pkgs/repl-help/README.md
@@ -51,7 +51,7 @@ The function accepts the following `options`:
 
 -   **dir**: root directory from which to search for package REPL help files. May be either an absolute path or a path relative to the current working directory. Default: current working directory.
 -   **pattern**: glob pattern used to find packages. Default: `'**/package.json'` (note: pattern **must** end with `package.json`).
--   **filename**: REPL help filename. May include a directory prefix (relative to a package's directory). Default: `docs/repl.txt`. 
+-   **filename**: REPL help filename. May include a directory prefix (relative to a package's directory). Default: `docs/repl.txt`.
 -   **ignore**: list of glob patterns used to exclude matches.
 
 To search from an alternative directory, set the `dir` option.
diff --git a/lib/node_modules/@stdlib/_tools/release/package-json/README.md b/lib/node_modules/@stdlib/_tools/release/package-json/README.md
@@ -53,7 +53,7 @@ The function accepts the following `options`:
 
 -   **devDependencies**: development dependencies to be added.
 
-To specify development dependencie to be added to the generated `package.json`, supply an array of dependency names for the `devDependencies` option:
+To specify development dependencies to be added to the generated `package.json`, supply an array of dependency names for the `devDependencies` option:
 
 ```javascript
 var out = prepare( '@stdlib/assert/is-object-array', {
@@ -86,9 +86,9 @@ var out = prepare( '@stdlib/assert/is-object-array', {
 var prepare = require( '@stdlib/_tools/release/package-json' );
 
 var out = prepare( '@stdlib/plot/ctor', {
-	'devDependencies': [
-		'tape'
-	]
+    'devDependencies': [
+        'tape'
+    ]
 });
 console.log( out );
 ```
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-img-equations-src-urls/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-img-equations-src-urls/README.md
@@ -140,7 +140,7 @@ console.log( out.contents );
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-eslint/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-eslint/README.md
@@ -46,7 +46,7 @@ var vfile = linter( '```javascript\nvar beep = \'boop\';\n```' );
 
 #### plugin.factory( \[options] )
 
-Returns a configured [remark][remark] plugin for linting JavaScript code blocks. 
+Returns a configured [remark][remark] plugin for linting JavaScript code blocks.
 
 ```javascript
 var remark = require( 'remark' );
@@ -244,7 +244,7 @@ console.log( out );
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 [eslint]: https://eslint.org/
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-namespace-toc/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-namespace-toc/README.md
@@ -84,7 +84,7 @@ console.log( out.contents );
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-run-javascript-examples/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-run-javascript-examples/README.md
@@ -322,7 +322,7 @@ function done( error ) {
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 [node-js]: http://nodejs.org/
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-related/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-related/README.md
@@ -88,7 +88,7 @@ console.log( out.contents );
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-urls-github/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-urls-github/README.md
@@ -79,11 +79,6 @@ var remark = require( 'remark' );
 var readFileSync = require( '@stdlib/fs/read-file' ).sync;
 var links = require( '@stdlib/_tools/remark/plugins/remark-stdlib-urls-github' );
 
-var fpath;
-var opts;
-var file;
-var out;
-
 // Load a Markdown file...
 var fpath = join( __dirname, 'examples', 'fixtures', 'simple.txt' );
 var opts = {
@@ -114,7 +109,7 @@ console.log( out.contents );
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-urls-www/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-stdlib-urls-www/README.md
@@ -114,7 +114,7 @@ console.log( out.contents );
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-svg-equations/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-svg-equations/README.md
@@ -121,7 +121,7 @@ function done( error, out ) {
 
 <section class="links">
 
-[remark]: https://github.com/wooorm/remark
+[remark]: https://github.com/remarkjs/remark
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/_tools/repl-txt/parse/package.json b/lib/node_modules/@stdlib/_tools/repl-txt/parse/package.json
@@ -50,7 +50,7 @@
     "doc",
     "parse",
     "ast",
-    "sytax",
+    "syntax",
     "tree"
   ]
 }
diff --git a/lib/node_modules/@stdlib/_tools/repl-txt/rules/line-length/lib/main.js b/lib/node_modules/@stdlib/_tools/repl-txt/rules/line-length/lib/main.js
@@ -58,7 +58,6 @@ function pkg2alias( pkg ) {
 * Rule for enforcing that lines in `repl.txt` files do not exceed a specified length.
 *
 * @param {Context} context - lint context
-* @param {Array} options - rule options
 * @returns {Object} validators
 */
 function main( context ) {
@@ -88,7 +87,7 @@ function main( context ) {
 	}
 
 	/**
-	* Replaces a matched alias annoation with the alias corresponding to the package path.
+	* Replaces a matched alias annotation with the alias corresponding to the package path.
 	*
 	* @private
 	* @param {string} match - alias annotation
diff --git a/lib/node_modules/@stdlib/_tools/tests/browser-build/README.md b/lib/node_modules/@stdlib/_tools/tests/browser-build/README.md
@@ -225,7 +225,7 @@ Options:
 
 ### Notes
 
--   If not provided a root directory, the root directory is the current working directory. 
+-   If not provided a root directory, the root directory is the current working directory.
 
 </section>
 

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ var debug = logger( 'to-reference:async' );`
`48`	`48`	`// MAIN //`
`49`	`49`
`50`	`50`	`/**`
`51`		`-* Asynchronously return a reference corresponding to a citation identifier.`
	`51`	`+* Asynchronously returns a reference corresponding to a citation identifier.`
`52`	`52`	`*`
`53`	`53`	`* @param {string} id - citation identifier`
`54`	`54`	`* @param {Options} [options] - function options`
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-tabs",`
`3`	`3`	`"version": "0.0.0",`
`4`		`- "description": "ESLint rule forbidding the use of tabs.",`
	`4`	`+ "description": "ESLint rule forbidding the use of tabs in JSDoc comments.",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"author": {`
`7`	`7`	`"name": "The Stdlib Authors",`