From 25d0fbf12e7054cbfd600246b15ee3e8fa448f99 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 12 Jan 2022 22:17:05 -0800 Subject: [PATCH] doc: remove SameValue comparison reference MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Referring to `Object.is()` will be more clear and direct. The `Object.is()` reference in turn refers to `SameValue` so people can dig deeper there if they want or need to. PR-URL: https://github.com/nodejs/node/pull/41460 Reviewed-By: Luigi Pinca Reviewed-By: Tobias Nießen Reviewed-By: Anna Henningsen Reviewed-By: Harshitha K P --- doc/api/assert.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index 5ed65dcbf05500..1987402958fe22 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -686,8 +686,7 @@ are recursively evaluated also by the following rules. ### Comparison details -* Primitive values are compared using the [SameValue Comparison][], used by - [`Object.is()`][]. +* Primitive values are compared using [`Object.is()`][]. * [Type tags][Object.prototype.toString()] of objects should be the same. * [`[[Prototype]]`][prototype-spec] of objects are compared using the [`===` operator][]. @@ -741,7 +740,7 @@ assert.deepStrictEqual(date, fakeDate); // - Date {} assert.deepStrictEqual(NaN, NaN); -// OK, because of the SameValue comparison +// OK because Object.is(NaN, NaN) is true. // Different unwrapped numbers: assert.deepStrictEqual(new Number(1), new Number(2)); @@ -757,7 +756,7 @@ assert.deepStrictEqual(new String('foo'), Object('foo')); assert.deepStrictEqual(-0, -0); // OK -// Different zeros using the SameValue Comparison: +// Different zeros: assert.deepStrictEqual(0, -0); // AssertionError: Expected inputs to be strictly deep-equal: // + actual - expected @@ -833,7 +832,7 @@ assert.deepStrictEqual(date, fakeDate); // - Date {} assert.deepStrictEqual(NaN, NaN); -// OK, because of the SameValue comparison +// OK because Object.is(NaN, NaN) is true. // Different unwrapped numbers: assert.deepStrictEqual(new Number(1), new Number(2)); @@ -849,7 +848,7 @@ assert.deepStrictEqual(new String('foo'), Object('foo')); assert.deepStrictEqual(-0, -0); // OK -// Different zeros using the SameValue Comparison: +// Different zeros: assert.deepStrictEqual(0, -0); // AssertionError: Expected inputs to be strictly deep-equal: // + actual - expected @@ -1734,7 +1733,7 @@ changes: * `message` {string|Error} Tests strict inequality between the `actual` and `expected` parameters as -determined by the [SameValue Comparison][]. +determined by [`Object.is()`][]. ```mjs import assert from 'assert/strict'; @@ -2026,7 +2025,7 @@ changes: * `message` {string|Error} Tests strict equality between the `actual` and `expected` parameters as -determined by the [SameValue Comparison][]. +determined by [`Object.is()`][]. ```mjs import assert from 'assert/strict'; @@ -2446,7 +2445,6 @@ argument. [Object wrappers]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive#Primitive_wrapper_objects_in_JavaScript [Object.prototype.toString()]: https://tc39.github.io/ecma262/#sec-object.prototype.tostring -[SameValue Comparison]: https://tc39.github.io/ecma262/#sec-samevalue [`!=` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Inequality [`===` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Strict_equality [`==` operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Equality