Skip to content

Commit a9d4530

Browse files
committed
docs: update example and function description
--- 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 57b0e74 commit a9d4530

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

lib/node_modules/@stdlib/math/base/special/minmaxabs/docs/repl.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@
3131

3232

3333
{{alias}}.assign( x, y, out, stride, offset )
34-
Returns the minimum and maximum absolute values.
34+
Returns the minimum and maximum absolute values and assigns results to a
35+
provided output array.
3536

3637
If any argument is `NaN`, the function returns `NaN` for both the minimum
3738
and maximum absolute values.

lib/node_modules/@stdlib/math/base/special/minmaxabs/docs/types/index.d.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222

2323
import { Collection } from '@stdlib/types/array';
2424

25+
/**
26+
* Interface describing an interface for computing minimum and maximum absolute values.
27+
*/
2528
interface MinMaxAbs {
2629
/**
2730
* Returns the minimum and maximum absolute values.
@@ -45,7 +48,7 @@ interface MinMaxAbs {
4548
( x: number, y: number ): Array<number>;
4649

4750
/**
48-
* Returns the minimum and maximum absolute values.
51+
* Returns the minimum and maximum absolute values and assigns results to a provided output array.
4952
*
5053
* @param x - first number
5154
* @param y - second number

lib/node_modules/@stdlib/math/base/special/minmaxabs/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
* v = minmaxabs( +0.0, -0.0 );
3939
* // returns [ 0.0, 0.0 ]
4040
*
41-
* v = minmaxabs( 3.14 );
41+
* v = minmaxabs( 3.14, -3.14 );
4242
* // returns [ 3.14, 3.14 ]
4343
*/
4444

0 commit comments

Comments
 (0)