doc: fix `notDeepEqual` API
authorMinwoo Jung <jmwsoft@gmail.com>
Sat, 30 Jan 2016 15:47:14 +0000 (00:47 +0900)
committerMyles Borins <mborins@us.ibm.com>
Wed, 2 Mar 2016 22:01:11 +0000 (14:01 -0800)
API calls in `assert` are `deepEqual()`, not `notDeepEqual()`.
use `notDeepEqual` to make it clear.

PR-URL: https://github.com/nodejs/node/pull/4971
Reviewed-By: Rich Trott <rtrott@gmail.com>
doc/api/assert.markdown

index 1750aed..08f3b70 100644 (file)
@@ -236,16 +236,16 @@ const obj3 = {
 }
 const obj4 = Object.create(obj1);
 
-assert.deepEqual(obj1, obj1);
-  AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }
+assert.notDeepEqual(obj1, obj1);
+  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }
 
-assert.deepEqual(obj1, obj2);
+assert.notDeepEqual(obj1, obj2);
   // OK, obj1 and obj2 are not deeply equal
 
-assert.deepEqual(obj1, obj3);
+assert.notDeepEqual(obj1, obj3);
   // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }
 
-assert.deepEqual(obj1, obj4);
+assert.notDeepEqual(obj1, obj4);
   // OK, obj1 and obj2 are not deeply equal
 ```