Skip to content

Commit 6fc31e1

Browse files
committed
docs: update return value descriptions
--- 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: 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 8e09d4f commit 6fc31e1

File tree

8 files changed

+8
-8
lines changed

8 files changed

+8
-8
lines changed

lib/node_modules/@stdlib/stats/base/ndarray/dmaxabs/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
Returns
1414
-------
1515
out: number
16-
Maximum value.
16+
Maximum absolute value.
1717

1818
Examples
1919
--------

lib/node_modules/@stdlib/stats/base/ndarray/dmaxabs/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { float64ndarray } from '@stdlib/types/ndarray';
2626
* Computes the maximum absolute value of a one-dimensional double-precision floating-point ndarray.
2727
*
2828
* @param arrays - array-like object containing an input ndarray
29-
* @returns maximum value
29+
* @returns maximum absolute value
3030
*
3131
* @example
3232
* var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/base/ndarray/dmaxabs/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var strided = require( '@stdlib/stats/strided/dmaxabs' ).ndarray;
3333
* Computes the maximum absolute value of a one-dimensional double-precision floating-point ndarray.
3434
*
3535
* @param {ArrayLikeObject<Object>} arrays - array-like object containing an input ndarray
36-
* @returns {number} maximum value
36+
* @returns {number} maximum absolute value
3737
*
3838
* @example
3939
* var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/stats/base/ndarray/maxabs/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
Returns
1313
-------
1414
out: number
15-
Maximum value.
15+
Maximum absolute value.
1616

1717
Examples
1818
--------

lib/node_modules/@stdlib/stats/base/ndarray/maxabs/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { ndarray } from '@stdlib/types/ndarray';
2626
* Computes the maximum absolute value of a one-dimensional ndarray.
2727
*
2828
* @param arrays - array-like object containing an input ndarray
29-
* @returns maximum value
29+
* @returns maximum absolute value
3030
*
3131
* @example
3232
* var ndarray = require( '@stdlib/ndarray/base/ctor' );

lib/node_modules/@stdlib/stats/base/ndarray/maxabs/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var strided = require( '@stdlib/stats/strided/maxabs' ).ndarray;
3333
* Computes the maximum absolute value of a one-dimensional ndarray.
3434
*
3535
* @param {ArrayLikeObject<Object>} arrays - array-like object containing an input ndarray
36-
* @returns {number} maximum value
36+
* @returns {number} maximum absolute value
3737
*
3838
* @example
3939
* var ndarray = require( '@stdlib/ndarray/base/ctor' );

lib/node_modules/@stdlib/stats/base/ndarray/smaxabs/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
Returns
1414
-------
1515
out: number
16-
Maximum value.
16+
Maximum absolute value.
1717

1818
Examples
1919
--------

lib/node_modules/@stdlib/stats/base/ndarray/smaxabs/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { float32ndarray } from '@stdlib/types/ndarray';
2626
* Computes the maximum absolute value of a one-dimensional single-precision floating-point ndarray.
2727
*
2828
* @param arrays - array-like object containing an input ndarray
29-
* @returns maximum value
29+
* @returns maximum absolute value
3030
*
3131
* @example
3232
* var Float32Array = require( '@stdlib/array/float32' );

0 commit comments

Comments
 (0)