doc: clarify eventType in fs.watch

'rename' is confusing, and it's not clear what "they" refers to. Fixes: #9082 PR-URL: #9318 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
nodejs · Nov 22, 2016 · d5fa1d5 · d5fa1d5
1 parent 3014dfd
commit d5fa1d5
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -1701,8 +1701,12 @@ The listener callback gets two arguments `(eventType, filename)`.  `eventType` i
 `'rename'` or `'change'`, and `filename` is the name of the file which triggered
 the event.
 
-Please note the listener callback is attached to the `'change'` event
-fired by [`fs.FSWatcher`][], but they are not the same thing.
+Note that on most platforms, `'rename'` is emitted whenever a filename appears
+or disappears in the directory.
+
+Also note the listener callback is attached to the `'change'` event fired by
+[`fs.FSWatcher`][], but it is not the same thing as the `'change'` value of
+`eventType`.
 
 ### Caveats