docs: fix example code and return annotation values

Planeshifter · Planeshifter · commit 8a6dbd7bf692 · 2025-08-21T22:52:06.000-05: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/dtypes2signatures/lib/index.js b/lib/node_modules/@stdlib/ndarray/base/dtypes2signatures/lib/index.js
@@ -31,7 +31,7 @@
 *     'float32', 'float32'
 * ];
 *
-* var sigs = dtypes2signatures( dtypes, 2, 0 );
+* var sigs = dtypes2signatures( dtypes, 1, 1 );
 * // returns [ '(float64) => (float64)', '(float32) => (float32)' ]
 */
 
diff --git a/lib/node_modules/@stdlib/ndarray/base/from-scalar-like/lib/index.js b/lib/node_modules/@stdlib/ndarray/base/from-scalar-like/lib/index.js
@@ -37,7 +37,7 @@
 * // returns []
 *
 * var dt = y.dtype;
-* // returns 'float64'
+* // returns 'float32'
 *
 * var v = y.get();
 * // returns 1.0
diff --git a/lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-arrays/lib/index.js b/lib/node_modules/@stdlib/ndarray/base/maybe-broadcast-arrays/lib/index.js
@@ -28,10 +28,10 @@
 * var zeros = require( '@stdlib/ndarray/zeros' );
 * var maybeBroadcastArrays = require( '@stdlib/ndarray/base/maybe-broadcast-arrays' );
 *
-* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+* var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 * // returns <ndarray>
 *
-* var shx = x.shape;
+* var shx = x1.shape;
 * // returns [ 2, 2 ]
 *
 * var y1 = zeros( [ 3, 2, 2 ] );
diff --git a/lib/node_modules/@stdlib/ndarray/iter/values/lib/index.js b/lib/node_modules/@stdlib/ndarray/iter/values/lib/index.js
@@ -30,7 +30,7 @@
 * var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
 * // returns <ndarray>
 *
-* var iter = nditerValues( x.shape );
+* var iter = nditerValues( x );
 *
 * var v = iter.next().value;
 * // returns 1
diff --git a/lib/node_modules/@stdlib/ndarray/maybe-broadcast-arrays/lib/index.js b/lib/node_modules/@stdlib/ndarray/maybe-broadcast-arrays/lib/index.js
@@ -28,10 +28,10 @@
 * var zeros = require( '@stdlib/ndarray/zeros' );
 * var maybeBroadcastArrays = require( '@stdlib/ndarray/maybe-broadcast-arrays' );
 *
-* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+* var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 * // returns <ndarray>
 *
-* var shx = x.shape;
+* var shx = x1.shape;
 * // returns [ 2, 2 ]
 *
 * var y1 = zeros( [ 3, 2, 2 ] );
diff --git a/lib/node_modules/@stdlib/random/strided/tools/binary-factory/lib/index.js b/lib/node_modules/@stdlib/random/strided/tools/binary-factory/lib/index.js
@@ -28,7 +28,7 @@
 * var arcsine = require( '@stdlib/random/base/arcsine' );
 * var binaryFactory = require( '@stdlib/random/strided/tools/binary-factory' );
 *
-* var factory = createFactory( arcsine );
+* var factory = binaryFactory( arcsine );
 * // returns <Function>
 *
 * var random = factory();
@@ -44,7 +44,7 @@
 * var arcsine = require( '@stdlib/random/base/arcsine' );
 * var binaryFactory = require( '@stdlib/random/strided/tools/binary-factory' );
 *
-* var factory = createFactory( arcsine );
+* var factory = binaryFactory( arcsine );
 * // returns <Function>
 *
 * var random = factory();
diff --git a/lib/node_modules/@stdlib/random/strided/tools/unary-factory/lib/index.js b/lib/node_modules/@stdlib/random/strided/tools/unary-factory/lib/index.js
@@ -28,7 +28,7 @@
 * var exponential = require( '@stdlib/random/base/exponential' );
 * var unaryFactory = require( '@stdlib/random/strided/tools/unary-factory' );
 *
-* var factory = createFactory( exponential );
+* var factory = unaryFactory( exponential );
 * // returns <Function>
 *
 * var random = factory();
@@ -44,7 +44,7 @@
 * var exponential = require( '@stdlib/random/base/exponential' );
 * var unaryFactory = require( '@stdlib/random/strided/tools/unary-factory' );
 *
-* var factory = createFactory( exponential );
+* var factory = unaryFactory( exponential );
 * // returns <Function>
 *
 * var random = factory();
diff --git a/lib/node_modules/@stdlib/random/tools/binary-factory/lib/index.js b/lib/node_modules/@stdlib/random/tools/binary-factory/lib/index.js
@@ -38,7 +38,7 @@
 *     'order': 'row-major'
 * };
 *
-* var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );
+* var factory = binaryFactory( uniform, [ idt, idt ], odt, policies, options );
 *
 * var rand = factory();
 * // returns <Function>
@@ -62,7 +62,7 @@
 *     'order': 'row-major'
 * };
 *
-* var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );
+* var factory = binaryFactory( uniform, [ idt, idt ], odt, policies, options );
 *
 * var rand = factory();
 * // returns <Function>
diff --git a/lib/node_modules/@stdlib/random/tools/unary-factory/lib/index.js b/lib/node_modules/@stdlib/random/tools/unary-factory/lib/index.js
@@ -38,7 +38,7 @@
 *     'order': 'row-major'
 * };
 *
-* var factory = createFactory( exponential, idt, odt, policies, options );
+* var factory = unaryFactory( exponential, idt, odt, policies, options );
 *
 * var rand = factory();
 * // returns <Function>
@@ -62,7 +62,7 @@
 *     'order': 'row-major'
 * };
 *
-* var factory = createFactory( exponential, idt, odt, policies, options );
+* var factory = unaryFactory( exponential, idt, odt, policies, options );
 *
 * var rand = factory();
 * // returns <Function>
diff --git a/lib/node_modules/@stdlib/utils/map2-right/lib/index.js b/lib/node_modules/@stdlib/utils/map2-right/lib/index.js
@@ -46,7 +46,7 @@
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );
 * var y = array( [ [ 1, 1, 1 ], [ 1, 1, 1 ] ], opts );
 *
-* var out = map2Right( x, y. naryFunction( add, 2 ) );
+* var out = map2Right( x, y, naryFunction( add, 2 ) );
 * // returns <ndarray>
 *
 * var data = out.data;

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`* 'float32', 'float32'`
`32`	`32`	`* ];`
`33`	`33`	`*`
`34`		`-* var sigs = dtypes2signatures( dtypes, 2, 0 );`
	`34`	`+* var sigs = dtypes2signatures( dtypes, 1, 1 );`
`35`	`35`	`* // returns [ '(float64) => (float64)', '(float32) => (float32)' ]`
`36`	`36`	`*/`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`* // returns []`
`38`	`38`	`*`
`39`	`39`	`* var dt = y.dtype;`
`40`		`-* // returns 'float64'`
	`40`	`+* // returns 'float32'`
`41`	`41`	`*`
`42`	`42`	`* var v = y.get();`
`43`	`43`	`* // returns 1.0`
Original file line number	Diff line number	Diff line change
`@@ -28,10 +28,10 @@`
`28`	`28`	`* var zeros = require( '@stdlib/ndarray/zeros' );`
`29`	`29`	`* var maybeBroadcastArrays = require( '@stdlib/ndarray/base/maybe-broadcast-arrays' );`
`30`	`30`	`*`
`31`		`-* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );`
	`31`	`+* var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );`
`32`	`32`	`* // returns <ndarray>`
`33`	`33`	`*`
`34`		`-* var shx = x.shape;`
	`34`	`+* var shx = x1.shape;`
`35`	`35`	`* // returns [ 2, 2 ]`
`36`	`36`	`*`
`37`	`37`	`* var y1 = zeros( [ 3, 2, 2 ] );`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );`
`31`	`31`	`* // returns <ndarray>`
`32`	`32`	`*`
`33`		`-* var iter = nditerValues( x.shape );`
	`33`	`+* var iter = nditerValues( x );`
`34`	`34`	`*`
`35`	`35`	`* var v = iter.next().value;`
`36`	`36`	`* // returns 1`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`* var arcsine = require( '@stdlib/random/base/arcsine' );`
`29`	`29`	`* var binaryFactory = require( '@stdlib/random/strided/tools/binary-factory' );`
`30`	`30`	`*`
`31`		`-* var factory = createFactory( arcsine );`
	`31`	`+* var factory = binaryFactory( arcsine );`
`32`	`32`	`* // returns <Function>`
`33`	`33`	`*`
`34`	`34`	`* var random = factory();`
`@@ -44,7 +44,7 @@`
`44`	`44`	`* var arcsine = require( '@stdlib/random/base/arcsine' );`
`45`	`45`	`* var binaryFactory = require( '@stdlib/random/strided/tools/binary-factory' );`
`46`	`46`	`*`
`47`		`-* var factory = createFactory( arcsine );`
	`47`	`+* var factory = binaryFactory( arcsine );`
`48`	`48`	`* // returns <Function>`
`49`	`49`	`*`
`50`	`50`	`* var random = factory();`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@`
`38`	`38`	`* 'order': 'row-major'`
`39`	`39`	`* };`
`40`	`40`	`*`
`41`		`-* var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );`
	`41`	`+* var factory = binaryFactory( uniform, [ idt, idt ], odt, policies, options );`
`42`	`42`	`*`
`43`	`43`	`* var rand = factory();`
`44`	`44`	`* // returns <Function>`
`@@ -62,7 +62,7 @@`
`62`	`62`	`* 'order': 'row-major'`
`63`	`63`	`* };`
`64`	`64`	`*`
`65`		`-* var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );`
	`65`	`+* var factory = binaryFactory( uniform, [ idt, idt ], odt, policies, options );`
`66`	`66`	`*`
`67`	`67`	`* var rand = factory();`
`68`	`68`	`* // returns <Function>`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@`
`46`	`46`	`* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts );`
`47`	`47`	`* var y = array( [ [ 1, 1, 1 ], [ 1, 1, 1 ] ], opts );`
`48`	`48`	`*`
`49`		`-* var out = map2Right( x, y. naryFunction( add, 2 ) );`
	`49`	`+* var out = map2Right( x, y, naryFunction( add, 2 ) );`
`50`	`50`	`* // returns <ndarray>`
`51`	`51`	`*`
`52`	`52`	`* var data = out.data;`