docs: update descriptions

kgryte · kgryte · commit d761114ce6f6 · 2025-03-21T04:39:19.000-07:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/0d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/0d.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/0d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/0d_accessors.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/10d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/10d.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/10d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/10d_accessors.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/10d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/10d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/10d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/10d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/1d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/1d.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/1d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/1d_accessors.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/2d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/2d.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/2d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/2d_accessors.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/2d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/2d_blocked.js
@@ -27,7 +27,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/2d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/2d_blocked_accessors.js
@@ -27,7 +27,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/3d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/3d.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/3d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/3d_accessors.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/3d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/3d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/3d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/3d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/4d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/4d.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/4d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/4d_accessors.js
@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/4d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/4d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/4d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/4d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/5d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/5d.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/5d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/5d_accessors.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/5d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/5d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/5d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/5d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/6d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/6d.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/6d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/6d_accessors.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/6d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/6d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/6d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/6d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/7d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/7d.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/7d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/7d_accessors.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/7d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/7d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/7d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/7d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/8d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/8d.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/8d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/8d_accessors.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/8d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/8d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/8d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/8d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/9d.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/9d.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/9d_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/9d_accessors.js
@@ -23,7 +23,7 @@
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/9d_blocked.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/9d_blocked.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/9d_blocked_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/9d_blocked_accessors.js
@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );
 // MAIN //
 
 /**
-* Tests whether every element is truthy via loop blocking.
+* Tests whether every element in an ndarray is truthy via loop blocking.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/main.js
@@ -173,7 +173,7 @@ var MAX_DIMS = EVERY.length - 1;
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * ## Notes
 *
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/nd.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/nd.js
@@ -32,7 +32,7 @@ var MODE = 'throw';
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/nd_accessors.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/nd_accessors.js
@@ -32,7 +32,7 @@ var MODE = 'throw';
 // MAIN //
 
 /**
-* Tests whether every element is truthy.
+* Tests whether every element in an ndarray is truthy.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`// MAIN //`
`22`	`22`
`23`	`23`	`/**`
`24`		`-* Tests whether every element is truthy.`
	`24`	`+* Tests whether every element in an ndarray is truthy.`
`25`	`25`	`*`
`26`	`26`	`* @private`
`27`	`27`	`* @param {Object} x - object containing ndarray meta data`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`// MAIN //`
`24`	`24`
`25`	`25`	`/**`
`26`		`-* Tests whether every element is truthy.`
	`26`	`+* Tests whether every element in an ndarray is truthy.`
`27`	`27`	`*`
`28`	`28`	`* @private`
`29`	`29`	`* @param {Object} x - object containing ndarray meta data`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ var blockSize = require( '@stdlib/ndarray/base/nullary-tiling-block-size' );`
`29`	`29`	`// MAIN //`
`30`	`30`
`31`	`31`	`/**`
`32`		`-* Tests whether every element is truthy via loop blocking.`
	`32`	`+* Tests whether every element in an ndarray is truthy via loop blocking.`
`33`	`33`	`*`
`34`	`34`	`* @private`
`35`	`35`	`* @param {Object} x - object containing ndarray meta data`