docs: fix various documentation issues

Planeshifter · Planeshifter · commit 50003a449621 · 2025-06-23T20:47:40.000-05:00
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-list-item-indent/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-list-item-indent/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # List Item Indent
 
-> [ESLint rule][eslint-rules] to spacing between a list item’s bullet and its content to violate a given style in JSDoc descriptions.
+> [ESLint rule][eslint-rules] to enforce spacing between a list item’s bullet and its content to match a given style in JSDoc descriptions.
 
 <section class="intro">
 
@@ -38,7 +38,7 @@ var rule = require( '@stdlib/_tools/eslint/rules/jsdoc-list-item-indent' );
 
 #### rule
 
-[ESLint rule][eslint-rules] to spacing between a list item’s bullet and its content to violate a given style in JSDoc descriptions.
+[ESLint rule][eslint-rules] to enforce spacing between a list item’s bullet and its content to match a given style in JSDoc descriptions.
 
 **Bad**:
 
diff --git a/lib/node_modules/@stdlib/_tools/github/create-issue/lib/main.js b/lib/node_modules/@stdlib/_tools/github/create-issue/lib/main.js
@@ -44,9 +44,9 @@ var DEFAULT_HTTPS_PORT = 443;
 * @param {string} title - issue title
 * @param {Options} options - function options
 * @param {string} options.token - GitHub access token
-* @param {string} [opts.protocol='https'] - request protocol
-* @param {string} [opts.hostname='api.github.com'] - endpoint hostname
-* @param {NonNegativeInteger} [opts.port] - endpoint port
+* @param {string} [options.protocol='https'] - request protocol
+* @param {string} [options.hostname='api.github.com'] - endpoint hostname
+* @param {NonNegativeInteger} [options.port] - endpoint port
 * @param {string} [options.useragent] - user agent string
 * @param {string} [options.body=""] - issue content
 * @param {StringArray} [options.assignees] - usernames of assigned users
diff --git a/lib/node_modules/@stdlib/_tools/github/create-repo/lib/main.js b/lib/node_modules/@stdlib/_tools/github/create-repo/lib/main.js
@@ -39,13 +39,13 @@ var factory = require( './factory.js' );
 * @param {string} [opts.license] - LICENSE template
 * @param {boolean} [opts.private=false] - boolean indicating whether a repository should be private
 * @param {boolean} [opts.issues=true] - boolean indicating whether issues should be enabled
-* @param {boolean} [options.projects=true] - boolean indicating whether project boards should be enabled
+* @param {boolean} [opts.projects=true] - boolean indicating whether project boards should be enabled
 * @param {boolean} [opts.wiki=true] - boolean indicating whether a repository should have a wiki
 * @param {boolean} [opts.downloads=true] - boolean indicating whether downloads should be enabled
 * @param {boolean} [opts.init=false] - boolean indicating whether to initialize the repository with an empty README
-* @param {boolean} [options.allowSquashMerge=true] - boolean indicating whether to allow squash-merging
-* @param {boolean} [options.allowMergeCommit=true] - boolean indicating whether to allow merging pull requests with a merge commit
-* @param {boolean} [options.allowRebaseMerge=true] - boolean indicating whether to allow rebase-merging pull requests
+* @param {boolean} [opts.allowSquashMerge=true] - boolean indicating whether to allow squash-merging
+* @param {boolean} [opts.allowMergeCommit=true] - boolean indicating whether to allow merging pull requests with a merge commit
+* @param {boolean} [opts.allowRebaseMerge=true] - boolean indicating whether to allow rebase-merging pull requests
 * @param {Function} clbk - callback to invoke upon query completion
 * @returns {void}
 */
diff --git a/lib/node_modules/@stdlib/_tools/github/dispatch-workflow/lib/main.js b/lib/node_modules/@stdlib/_tools/github/dispatch-workflow/lib/main.js
@@ -44,9 +44,9 @@ var DEFAULT_HTTPS_PORT = 443;
 * @param {string} id - workflow id or workflow file name
 * @param {Options} options - function options
 * @param {string} options.token - GitHub access token
-* @param {string} [opts.protocol='https'] - request protocol
-* @param {string} [opts.hostname='api.github.com'] - endpoint hostname
-* @param {NonNegativeInteger} [opts.port] - endpoint port
+* @param {string} [options.protocol='https'] - request protocol
+* @param {string} [options.hostname='api.github.com'] - endpoint hostname
+* @param {NonNegativeInteger} [options.port] - endpoint port
 * @param {string} [options.useragent] - user agent string
 * @param {string} [options.ref='main'] - git reference for the workflow (branch or tag name)
 * @param {Object} [options.inputs] - input key-value pairs overriding the defaults specified in the workflow file
diff --git a/lib/node_modules/@stdlib/_tools/github/starred/lib/index.js b/lib/node_modules/@stdlib/_tools/github/starred/lib/index.js
@@ -43,7 +43,7 @@
 *         throw new Error( error.message );
 *     }
 *     console.log( JSON.stringify( results ) );
-*     // returns <repo_data>
+*     // => <repo_data>
 * }
 */
 
diff --git a/lib/node_modules/@stdlib/_tools/github/subscriptions/lib/index.js b/lib/node_modules/@stdlib/_tools/github/subscriptions/lib/index.js
@@ -43,7 +43,7 @@
 *         throw new Error( error.message );
 *     }
 *     console.log( JSON.stringify( results ) );
-*     // returns <repo_data>
+*     // => <repo_data>
 * }
 */
 
diff --git a/lib/node_modules/@stdlib/_tools/pkgs/includes/README.md b/lib/node_modules/@stdlib/_tools/pkgs/includes/README.md
@@ -135,7 +135,7 @@ The function accepts the same `options` as `findIncludes()` above.
 
 ## Notes
 
--   The implementation resolves package `include` directories by checking for a `directories.include` field in a package's `package.json` file. 
+-   The implementation resolves package `include` directories by checking for a `directories.include` field in a package's `package.json` file.
 -   **No** attempt is made to ensure that a package actually has the indicated `include` directory.
 
 </section>
diff --git a/lib/node_modules/@stdlib/_tools/pkgs/installed/README.md b/lib/node_modules/@stdlib/_tools/pkgs/installed/README.md
@@ -38,7 +38,7 @@ var pkgs = require( '@stdlib/_tools/pkgs/installed' );
 
 #### pkgs( \[options], clbk )
 
-Generates a list of installed package dependencies. 
+Generates a list of installed package dependencies.
 
 ```javascript
 pkgs( onPkgs );
