From 92d2f2ce89e3d250f3faf2d22cb93096046177ad Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 4 Dec 2017 19:57:25 -0800 Subject: [PATCH 1/4] doc: use colon consistently in assert.md --- doc/api/assert.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index 11def69df9a0cd..cf2212c90e13f3 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -510,13 +510,13 @@ assert.notDeepEqual(obj1, obj1); // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } } assert.notDeepEqual(obj1, obj2); -// OK, obj1 and obj2 are not deeply equal +// OK: obj1 and obj2 are not deeply equal assert.notDeepEqual(obj1, obj3); // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } } assert.notDeepEqual(obj1, obj4); -// OK, obj1 and obj4 are not deeply equal +// OK: obj1 and obj4 are not deeply equal ``` If the values are deeply equal, an `AssertionError` is thrown with a `message` From f363d919a87cba7e0037173df18cae4b89bea4e4 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 4 Dec 2017 23:39:51 -0800 Subject: [PATCH 2/4] doc: improve punctuation in fs.open() text --- doc/api/fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 0bbfd41d80818c..dbf10efae4a395 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1672,7 +1672,7 @@ The file is created if it does not exist. * `'ax+'` - Like `'a+'` but fails if `path` exists. `mode` sets the file mode (permission and sticky bits), but only if the file was -created. It defaults to `0o666`, readable and writable. +created. It defaults to `0o666` (readable and writable). The callback gets two arguments `(err, fd)`. From 48c477a469cc4762c5baa9c27a00cd0324e60a54 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 4 Dec 2017 23:43:20 -0800 Subject: [PATCH 3/4] doc: standardize preposition usage in fs.md "On " is used everywhere in this file except for one use of "In ". Standardize to "On". --- doc/api/fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index dbf10efae4a395..8bc585d3a7291a 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2568,7 +2568,7 @@ a new inode. The watch will emit an event for the delete but will continue watching the *original* inode. Events for the new inode will not be emitted. This is expected behavior. -In AIX, save and close of a file being watched causes two notifications - +On AIX, save and close of a file being watched causes two notifications - one for adding new content, and one for truncation. Moreover, save and close operations on some platforms cause inode changes that force watch operations to become invalid and ineffective. AIX retains inode for the From 69e7d3e4c9b764bbbc69b5a4180f54c6a5b6a07c Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 4 Dec 2017 23:47:39 -0800 Subject: [PATCH 4/4] doc: edit module introduction The module introduction includes some uninformative text and some repetitive text. Edit for clarity and brevity. --- doc/api/modules.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/api/modules.md b/doc/api/modules.md index f9f311d241ce92..8ca81cbda2f42f 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -6,10 +6,8 @@ -Node.js has a simple module loading system. In Node.js, files and modules -are in one-to-one correspondence (each file is treated as a separate module). - -As an example, consider a file named `foo.js`: +In the Node.js module system, each file is treated as a separate module. For +example, consider a file named `foo.js`: ```js const circle = require('./circle.js');