Skip to content

Commit 49b8ea8

Browse files
committed
docs: align test descriptions with canonical complex-number wording
Propagates fixes from b0713ea ("docs: update descriptions to be consistent with elsewhere in project") and a3a5677 ("docs: follow-up fixes") to test descriptions that still use the reverse word order "complex {single,double}-precision floating-point". Project canonical wording is "{single,double}-precision complex floating-point", which matches the JSDoc in each package's `lib/main.js`. Affected packages: - `complex/float32/base/assert/is-almost-equal` - `complex/float32/base/assert/is-almost-same-value` - `complex/float64/base/assert/is-almost-equal` - `complex/float64/base/assert/is-almost-same-value`
1 parent 508e136 commit 49b8ea8

4 files changed

Lines changed: 12 additions & 12 deletions

File tree

  • lib/node_modules/@stdlib/complex
    • float32/base/assert
    • float64/base/assert

lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-equal/test/test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ tape( 'the function returns `false` if provided `NaN` as either real or imaginar
5555
t.end();
5656
});
5757

58-
tape( 'the function returns `true` if provided two complex single-precision floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
58+
tape( 'the function returns `true` if provided two single-precision complex floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
5959
var z1;
6060
var z2;
6161

@@ -77,7 +77,7 @@ tape( 'the function returns `true` if provided two complex single-precision floa
7777
t.end();
7878
});
7979

80-
tape( 'the function returns `true` if provided two complex single-precision floating-point numbers which are approximately equal within a specified number of ULPs', function test( t ) {
80+
tape( 'the function returns `true` if provided two single-precision complex floating-point numbers which are approximately equal within a specified number of ULPs', function test( t ) {
8181
var z1;
8282
var z2;
8383

@@ -93,7 +93,7 @@ tape( 'the function returns `true` if provided two complex single-precision floa
9393
t.end();
9494
});
9595

96-
tape( 'the function returns `false` if provided two complex single-precision floating-point numbers which are not approximately equal within a specified number of ULPs', function test( t ) {
96+
tape( 'the function returns `false` if provided two single-precision complex floating-point numbers which are not approximately equal within a specified number of ULPs', function test( t ) {
9797
var z1;
9898
var z2;
9999

lib/node_modules/@stdlib/complex/float32/base/assert/is-almost-same-value/test/test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ tape( 'the function treats `NaNs` as the same value', function test( t ) {
5555
t.end();
5656
});
5757

58-
tape( 'the function returns `true` if provided two complex single-precision floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
58+
tape( 'the function returns `true` if provided two single-precision complex floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
5959
var z1;
6060
var z2;
6161

@@ -77,7 +77,7 @@ tape( 'the function returns `true` if provided two complex single-precision floa
7777
t.end();
7878
});
7979

80-
tape( 'the function returns `true` if provided two complex single-precision floating-point numbers which are approximately the same value within a specified number of ULPs', function test( t ) {
80+
tape( 'the function returns `true` if provided two single-precision complex floating-point numbers which are approximately the same value within a specified number of ULPs', function test( t ) {
8181
var z1;
8282
var z2;
8383

@@ -93,7 +93,7 @@ tape( 'the function returns `true` if provided two complex single-precision floa
9393
t.end();
9494
});
9595

96-
tape( 'the function returns `false` if provided two complex single-precision floating-point numbers which are not approximately the same value within a specified number of ULPs', function test( t ) {
96+
tape( 'the function returns `false` if provided two single-precision complex floating-point numbers which are not approximately the same value within a specified number of ULPs', function test( t ) {
9797
var z1;
9898
var z2;
9999

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-equal/test/test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ tape( 'the function returns `false` if provided `NaN` as either real or imaginar
5555
t.end();
5656
});
5757

58-
tape( 'the function returns `true` if provided two complex double-precision floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
58+
tape( 'the function returns `true` if provided two double-precision complex floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
5959
var z1;
6060
var z2;
6161

@@ -77,7 +77,7 @@ tape( 'the function returns `true` if provided two complex double-precision floa
7777
t.end();
7878
});
7979

80-
tape( 'the function returns `true` if provided two complex double-precision floating-point numbers which are approximately equal within a specified number of ULPs', function test( t ) {
80+
tape( 'the function returns `true` if provided two double-precision complex floating-point numbers which are approximately equal within a specified number of ULPs', function test( t ) {
8181
var z1;
8282
var z2;
8383

@@ -93,7 +93,7 @@ tape( 'the function returns `true` if provided two complex double-precision floa
9393
t.end();
9494
});
9595

96-
tape( 'the function returns `false` if provided two complex double-precision floating-point numbers which are not approximately equal within a specified number of ULPs', function test( t ) {
96+
tape( 'the function returns `false` if provided two double-precision complex floating-point numbers which are not approximately equal within a specified number of ULPs', function test( t ) {
9797
var z1;
9898
var z2;
9999

lib/node_modules/@stdlib/complex/float64/base/assert/is-almost-same-value/test/test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ tape( 'the function treats `NaNs` as the same value', function test( t ) {
5555
t.end();
5656
});
5757

58-
tape( 'the function returns `true` if provided two complex double-precision floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
58+
tape( 'the function returns `true` if provided two double-precision complex floating-point numbers which are the same value irrespective of the specified number of ULPs', function test( t ) {
5959
var z1;
6060
var z2;
6161

@@ -77,7 +77,7 @@ tape( 'the function returns `true` if provided two complex double-precision floa
7777
t.end();
7878
});
7979

80-
tape( 'the function returns `true` if provided two complex double-precision floating-point numbers which are approximately the same value within a specified number of ULPs', function test( t ) {
80+
tape( 'the function returns `true` if provided two double-precision complex floating-point numbers which are approximately the same value within a specified number of ULPs', function test( t ) {
8181
var z1;
8282
var z2;
8383

@@ -93,7 +93,7 @@ tape( 'the function returns `true` if provided two complex double-precision floa
9393
t.end();
9494
});
9595

96-
tape( 'the function returns `false` if provided two complex double-precision floating-point numbers which are not approximately the same value within a specified number of ULPs', function test( t ) {
96+
tape( 'the function returns `false` if provided two double-precision complex floating-point numbers which are not approximately the same value within a specified number of ULPs', function test( t ) {
9797
var z1;
9898
var z2;
9999

0 commit comments

Comments
 (0)