Skip to content

Commit 51823d9

Browse files
committed
feat!: rename aliases
BREAKING CHANGE: rename aliases for `isSameValuef` and `isSameValueZerof` This commit renames the aliases by dropping the `f` suffix. This suffix was primarily used to distinguish symbols co-existing in the same namespace as double-precision counterparts. Here, however, that is not applicable as these symbols are co-localized with only other single-precision utilities. Hence, to minimize naming variations between namespaces, the symbols have been renamed. To migrate, users should simply drop the `f` suffix. --- 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: na - 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: passed - task: lint_license_headers status: passed ---
1 parent 0f795ff commit 51823d9

File tree

1 file changed

+12
-12
lines changed
  • lib/node_modules/@stdlib/number/float32/base/assert/docs/types

1 file changed

+12
-12
lines changed

lib/node_modules/@stdlib/number/float32/base/assert/docs/types/index.d.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
/* eslint-disable max-lines */
2222

2323
import isAlmostEqual = require( '@stdlib/number/float32/base/assert/is-almost-equal' );
24-
import isSameValuef = require( '@stdlib/number/float32/base/assert/is-same-value' );
25-
import isSameValueZerof = require( '@stdlib/number/float32/base/assert/is-same-value-zero' );
24+
import isSameValue = require( '@stdlib/number/float32/base/assert/is-same-value' );
25+
import isSameValueZero = require( '@stdlib/number/float32/base/assert/is-same-value-zero' );
2626

2727
/**
2828
* Interface describing the `assert` namespace.
@@ -81,28 +81,28 @@ interface Namespace {
8181
* @example
8282
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
8383
*
84-
* var bool = ns.isSameValuef( toFloat32( 3.14 ), toFloat32( 3.14 ) );
84+
* var bool = ns.isSameValue( toFloat32( 3.14 ), toFloat32( 3.14 ) );
8585
* // returns true
8686
*
8787
* @example
8888
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
8989
*
90-
* var bool = ns.isSameValuef( toFloat32( -0.0 ), toFloat32( -0.0 ) );
90+
* var bool = ns.isSameValue( toFloat32( -0.0 ), toFloat32( -0.0 ) );
9191
* // returns true
9292
*
9393
* @example
9494
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
9595
*
96-
* var bool = ns.isSameValuef( toFloat32( -0.0 ), toFloat32( 0.0 ) );
96+
* var bool = ns.isSameValue( toFloat32( -0.0 ), toFloat32( 0.0 ) );
9797
* // returns false
9898
*
9999
* @example
100100
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
101101
*
102-
* var bool = ns.isSameValuef( toFloat32( NaN ), toFloat32( NaN ) );
102+
* var bool = ns.isSameValue( toFloat32( NaN ), toFloat32( NaN ) );
103103
* // returns true
104104
*/
105-
isSameValuef: typeof isSameValuef;
105+
isSameValue: typeof isSameValue;
106106

107107
/**
108108
* Tests if two single-precision floating-point numbers are the same value.
@@ -118,28 +118,28 @@ interface Namespace {
118118
* @example
119119
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
120120
*
121-
* var bool = ns.isSameValueZerof( toFloat32( 3.14 ), toFloat32( 3.14 ) );
121+
* var bool = ns.isSameValueZero( toFloat32( 3.14 ), toFloat32( 3.14 ) );
122122
* // returns true
123123
*
124124
* @example
125125
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
126126
*
127-
* var bool = ns.isSameValueZerof( toFloat32( -0.0 ), toFloat32( -0.0 ) );
127+
* var bool = ns.isSameValueZero( toFloat32( -0.0 ), toFloat32( -0.0 ) );
128128
* // returns true
129129
*
130130
* @example
131131
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
132132
*
133-
* var bool = ns.isSameValueZerof( toFloat32( -0.0 ), toFloat32( 0.0 ) );
133+
* var bool = ns.isSameValueZero( toFloat32( -0.0 ), toFloat32( 0.0 ) );
134134
* // returns true
135135
*
136136
* @example
137137
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
138138
*
139-
* var bool = ns.isSameValueZerof( toFloat32( NaN ), toFloat32( NaN ) );
139+
* var bool = ns.isSameValueZero( toFloat32( NaN ), toFloat32( NaN ) );
140140
* // returns true
141141
*/
142-
isSameValueZerof: typeof isSameValueZerof;
142+
isSameValueZero: typeof isSameValueZero;
143143
}
144144

145145
/**

0 commit comments

Comments
 (0)