Skip to content

Commit bc8edad

Browse files
committed
docs: fix examples
--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent b7ebe14 commit bc8edad

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

lib/node_modules/@stdlib/number/float64/base/assert/is-almost-equal-value/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
3838
* // returns true
3939
*
40-
* var bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
40+
* bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
4141
* // returns true
4242
*
4343
* bool = isAlmostEqualValue( 1.0, 1.0+EPS+EPS, 1 );

lib/node_modules/@stdlib/number/float64/base/assert/is-almost-equal-value/lib/index.js

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,29 @@
2424
* @module @stdlib/number/float64/base/assert/is-almost-equal-value
2525
*
2626
* @example
27+
* var EPS = require( '@stdlib/constants/float64/eps' );
2728
* var isAlmostEqualValue = require( '@stdlib/number/float64/base/assert/is-almost-equal-value' );
2829
*
29-
* var bool = isAlmostEqualValue( 3.14, 3.14 );
30+
* var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
3031
* // returns true
3132
*
32-
* bool = isAlmostEqualValue( -0.0, -0.0 );
33+
* bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
3334
* // returns true
3435
*
35-
* bool = isAlmostEqualValue( -0.0, 0.0 );
36+
* bool = isAlmostEqualValue( 1.0, 1.0+EPS+EPS, 1 );
3637
* // returns false
3738
*
38-
* bool = isAlmostEqualValue( NaN, NaN );
39+
* bool = isAlmostEqualValue( 1.0, 1.0+EPS, 0 );
40+
* // returns false
41+
*
42+
* bool = isAlmostEqualValue( 0.0, -0.0, 0 );
3943
* // returns true
44+
*
45+
* bool = isAlmostEqualValue( 1.0, NaN, 1 );
46+
* // returns false
47+
*
48+
* bool = isAlmostEqualValue( NaN, NaN, 1 );
49+
* // returns false
4050
*/
4151

4252
// MODULES //

lib/node_modules/@stdlib/number/float64/base/assert/is-almost-equal-value/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ var ulpdiff = require( '@stdlib/number/float64/base/ulp-difference' );
4444
* var bool = isAlmostEqualValue( 1.0, 1.0+EPS, 1 );
4545
* // returns true
4646
*
47-
* var bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
47+
* bool = isAlmostEqualValue( 1.0+EPS, 1.0, 1 );
4848
* // returns true
4949
*
5050
* bool = isAlmostEqualValue( 1.0, 1.0+EPS+EPS, 1 );

0 commit comments

Comments
 (0)