docs: update markup

kgryte · kgryte · commit a3e79786217b · 2025-09-17T17:02:10.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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - 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/any-by/README.md b/lib/node_modules/@stdlib/ndarray/base/any-by/README.md
@@ -82,7 +82,7 @@ The function accepts the following arguments:
 -   **predicate**: predicate function.
 -   **thisArg**: predicate function execution context (_optional_).
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/any-by/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/any-by/docs/repl.txt
@@ -3,7 +3,7 @@
     Tests whether at least one element in an ndarray passes a test implemented
     by a predicate function.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/any-by/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/any-by/lib/main.js
@@ -127,7 +127,7 @@ var MAX_DIMS = ANY.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/any/README.md b/lib/node_modules/@stdlib/ndarray/base/any/README.md
@@ -76,7 +76,7 @@ The function accepts the following arguments:
 
 -   **arrays**: array-like object containing an input ndarray.
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/any/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/any/docs/repl.txt
@@ -2,7 +2,7 @@
 {{alias}}( arrays )
     Tests whether at least one element in an ndarray is truthy.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/any/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/any/lib/main.js
@@ -177,7 +177,7 @@ var MAX_DIMS = ANY.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/assign/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/assign/lib/main.js
@@ -195,7 +195,7 @@ function complex2real( x ) {
 *
 * ## Notes
 *
-* -   Each provided ndarray should be an `object` with the following properties:
+* -   Each provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/binary/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/binary/lib/main.js
@@ -146,7 +146,7 @@ function hasAccessors( x, y, z ) {
 *
 * ## Notes
 *
-* -   Each provided ndarray should be an `object` with the following properties:
+* -   Each provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-falsy/README.md b/lib/node_modules/@stdlib/ndarray/base/count-falsy/README.md
@@ -76,7 +76,7 @@ The function accepts the following arguments:
 
 -   **arrays**: array-like object containing an input ndarray.
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-falsy/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/count-falsy/docs/repl.txt
@@ -2,7 +2,7 @@
 {{alias}}( arrays )
     Counts the number of falsy elements in an ndarray.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-falsy/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/count-falsy/lib/main.js
@@ -177,7 +177,7 @@ var MAX_DIMS = COUNT.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-if/README.md b/lib/node_modules/@stdlib/ndarray/base/count-if/README.md
@@ -82,7 +82,7 @@ The function accepts the following arguments:
 -   **predicate**: predicate function.
 -   **thisArg**: predicate function execution context (_optional_).
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-if/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/count-if/docs/repl.txt
@@ -3,7 +3,7 @@
     Counts the number of elements in an ndarray which pass a test implemented by
     a predicate function.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-if/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/count-if/lib/main.js
@@ -127,7 +127,7 @@ var MAX_DIMS = COUNT.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-truthy/README.md b/lib/node_modules/@stdlib/ndarray/base/count-truthy/README.md
@@ -76,7 +76,7 @@ The function accepts the following arguments:
 
 -   **arrays**: array-like object containing an input ndarray.
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-truthy/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/count-truthy/docs/repl.txt
@@ -2,7 +2,7 @@
 {{alias}}( arrays )
     Counts the number of truthy elements in an ndarray.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/count-truthy/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/count-truthy/lib/main.js
@@ -177,7 +177,7 @@ var MAX_DIMS = COUNT.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/ctor/README.md b/lib/node_modules/@stdlib/ndarray/base/ctor/README.md
@@ -236,11 +236,11 @@ var dtype = arr.dtype;
 
 #### ndarray.prototype.flags
 
-Meta information, such as information concerning the memory layout of the array. The returned `object` has the following properties:
+Meta information, such as information concerning the memory layout of the array. The returned object has the following properties:
 
--   **ROW_MAJOR_CONTIGUOUS**: `boolean` indicating if an array is row-major contiguous.
--   **COLUMN_MAJOR_CONTIGUOUS**: `boolean` indicating if an array is column-major contiguous.
--   **READONLY**: `boolean` indicating if an array is **read-only**.
+-   **ROW_MAJOR_CONTIGUOUS**: boolean indicating if an array is row-major contiguous.
+-   **COLUMN_MAJOR_CONTIGUOUS**: boolean indicating if an array is column-major contiguous.
+-   **READONLY**: boolean indicating if an array is **read-only**.
 
 An array is contiguous if (1) an array is compatible with being stored in a single memory segment and (2) each array element is adjacent to the next array element. Note that an array can be both row-major contiguous and column-major contiguous at the same time (e.g., if an array is a 1-dimensional ndarray with `strides = [1]`).
 
@@ -538,7 +538,7 @@ The method does **not** serialize data outside of the buffer region defined by t
 
 #### ndarray.prototype.toJSON()
 
-Serializes an `ndarray` as a [JSON][json] `object`. `JSON.stringify()` implicitly calls this method when stringifying an `ndarray` instance.
+Serializes an `ndarray` as a [JSON][json] object. `JSON.stringify()` implicitly calls this method when stringifying an `ndarray` instance.
 
 ```javascript
 // Specify the array configuration:
diff --git a/lib/node_modules/@stdlib/ndarray/base/every-by/README.md b/lib/node_modules/@stdlib/ndarray/base/every-by/README.md
@@ -82,7 +82,7 @@ The function accepts the following arguments:
 -   **predicate**: predicate function.
 -   **thisArg**: predicate function execution context (_optional_).
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/every-by/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/every-by/docs/repl.txt
@@ -3,7 +3,7 @@
     Tests whether all elements in an ndarray pass a test implemented by a
     predicate function.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/every-by/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/every-by/lib/main.js
@@ -127,7 +127,7 @@ var MAX_DIMS = EVERY.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/README.md b/lib/node_modules/@stdlib/ndarray/base/every/README.md
@@ -76,7 +76,7 @@ The function accepts the following arguments:
 
 -   **arrays**: array-like object containing an input ndarray.
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/every/docs/repl.txt
@@ -2,7 +2,7 @@
 {{alias}}( arrays )
     Tests whether every element in an ndarray is truthy.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/every/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/every/lib/main.js
@@ -177,7 +177,7 @@ var MAX_DIMS = EVERY.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/find/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/find/docs/repl.txt
@@ -3,7 +3,7 @@
     Returns the first element in an ndarray which passes a test implemented by a
     predicate function.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/find/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/find/lib/main.js
@@ -86,7 +86,7 @@ var MAX_DIMS = FIND.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/for-each/README.md b/lib/node_modules/@stdlib/ndarray/base/for-each/README.md
@@ -91,7 +91,7 @@ The callback function is provided the following arguments:
 
 ## Notes
 
--   The provided ndarray should be an `object` with the following properties:
+-   The provided ndarray should be an object with the following properties:
 
     -   **dtype**: data type.
     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/for-each/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/for-each/lib/main.js
@@ -127,7 +127,7 @@ var MAX_DIMS = FOR_EACH.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/includes/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/includes/docs/repl.txt
@@ -2,7 +2,7 @@
 {{alias}}( arrays )
     Tests whether an ndarray contains a specified value.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/includes/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/includes/lib/main.js
@@ -181,7 +181,7 @@ var MAX_DIMS = INCLUDES.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/map/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/map/lib/main.js
@@ -128,7 +128,7 @@ var MAX_DIMS = MAP.length -1;
 *
 * ## Notes
 *
-* -   Each provided ndarray should be an `object` with the following properties:
+* -   Each provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/meta-data-props/README.md b/lib/node_modules/@stdlib/ndarray/base/meta-data-props/README.md
@@ -66,7 +66,7 @@ var obj = {};
 setProps( meta, dtypes, obj );
 ```
 
-The `meta` data argument should be an `object` with the following properties:
+The `meta` data argument should be an object with the following properties:
 
 -   **nargs**: total number of arguments. This value is one more than might be expected, as the output array is treated as an implicit argument, even when not explicitly provided.
 -   **nin**: number of input ndarrays.
diff --git a/lib/node_modules/@stdlib/ndarray/base/nullary/README.md b/lib/node_modules/@stdlib/ndarray/base/nullary/README.md
@@ -83,7 +83,7 @@ The function accepts the following arguments:
 -   **arrays**: array-like object containing an output ndarray.
 -   **fcn**: nullary function to apply.
 
-The provided ndarray should be an `object` with the following properties:
+The provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/nullary/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/nullary/docs/repl.txt
@@ -3,7 +3,7 @@
     Applies a nullary callback and assigns results to elements in an output
     ndarray.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/nullary/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/nullary/lib/main.js
@@ -127,7 +127,7 @@ var MAX_DIMS = NULLARY.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/some-by/README.md b/lib/node_modules/@stdlib/ndarray/base/some-by/README.md
@@ -88,7 +88,7 @@ The function accepts the following arguments:
 -   **predicate**: predicate function.
 -   **thisArg**: predicate function execution context (_optional_).
 
-Each provided ndarray should be an `object` with the following properties:
+Each provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/some-by/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/some-by/docs/repl.txt
@@ -3,7 +3,7 @@
     Tests whether at least `n` elements in an ndarray pass a test implemented by
     a predicate function.
 
-    A provided "ndarray" should be an `object` with the following properties:
+    A provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/some-by/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/some-by/lib/main.js
@@ -127,7 +127,7 @@ var MAX_DIMS = SOME.length - 1;
 *
 * ## Notes
 *
-* -   A provided ndarray should be an `object` with the following properties:
+* -   A provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/unary-by/README.md b/lib/node_modules/@stdlib/ndarray/base/unary-by/README.md
@@ -98,7 +98,7 @@ The function accepts the following arguments:
 -   **arrays**: array-like object containing one input ndarray and one output ndarray.
 -   **fcn**: unary function to apply.
 
-Each provided ndarray should be an `object` with the following properties:
+Each provided ndarray should be an object with the following properties:
 
 -   **dtype**: data type.
 -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/unary-by/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/base/unary-by/docs/repl.txt
@@ -4,7 +4,7 @@
     according to a callback function and assigns results to elements in an
     output ndarray.
 
-    Each provided "ndarray" should be an `object` with the following properties:
+    Each provided "ndarray" should be an object with the following properties:
 
     - dtype: data type.
     - data: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/unary-by/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/unary-by/lib/main.js
@@ -128,7 +128,7 @@ var MAX_DIMS = UNARY.length - 1;
 *
 * ## Notes
 *
-* -   Each provided ndarray should be an `object` with the following properties:
+* -   Each provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/base/unary/lib/main.js b/lib/node_modules/@stdlib/ndarray/base/unary/lib/main.js
@@ -129,7 +129,7 @@ var MAX_DIMS = UNARY.length - 1;
 *
 * ## Notes
 *
-* -   Each provided ndarray should be an `object` with the following properties:
+* -   Each provided ndarray should be an object with the following properties:
 *
 *     -   **dtype**: data type.
 *     -   **data**: data buffer.
diff --git a/lib/node_modules/@stdlib/ndarray/ctor/README.md b/lib/node_modules/@stdlib/ndarray/ctor/README.md

Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ var MAX_DIMS = ANY.length - 1;`
`127`	`127`	`*`
`128`	`128`	`* ## Notes`
`129`	`129`	`*`
`130`		-* - A provided ndarray should be an `object` with the following properties:
	`130`	`+* - A provided ndarray should be an object with the following properties:`
`131`	`131`	`*`
`132`	`132`	`* - dtype: data type.`
`133`	`133`	`* - data: data buffer.`
Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ var MAX_DIMS = ANY.length - 1;`
`177`	`177`	`*`
`178`	`178`	`* ## Notes`
`179`	`179`	`*`
`180`		-* - A provided ndarray should be an `object` with the following properties:
	`180`	`+* - A provided ndarray should be an object with the following properties:`
`181`	`181`	`*`
`182`	`182`	`* - dtype: data type.`
`183`	`183`	`* - data: data buffer.`
Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ function complex2real( x ) {`
`195`	`195`	`*`
`196`	`196`	`* ## Notes`
`197`	`197`	`*`
`198`		-* - Each provided ndarray should be an `object` with the following properties:
	`198`	`+* - Each provided ndarray should be an object with the following properties:`
`199`	`199`	`*`
`200`	`200`	`* - dtype: data type.`
`201`	`201`	`* - data: data buffer.`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ function hasAccessors( x, y, z ) {`
`146`	`146`	`*`
`147`	`147`	`* ## Notes`
`148`	`148`	`*`
`149`		-* - Each provided ndarray should be an `object` with the following properties:
	`149`	`+* - Each provided ndarray should be an object with the following properties:`
`150`	`150`	`*`
`151`	`151`	`* - dtype: data type.`
`152`	`152`	`* - data: data buffer.`