From 928166c4a8a7c630af047eb33bbf1bab9353c71b Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 27 Sep 2015 20:08:43 -0700 Subject: [PATCH] doc: copyedit fs.watch() information MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Removed "Only FSEvents supports this type of file watching so it is unlikely any additional platforms will be added soon." Per @saghul, "FSEvents" refers to the OSX API, but since we added Windows support it may not be unlikely that we add more. PR-URL: https://github.com/nodejs/node/pull/3097 Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Michaël Zasso Reviewed-By: Saúl Ibarra Corretgé --- doc/api/fs.markdown | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index 0b5adab793a8ec..e535ce64e283e9 100644 --- a/doc/api/fs.markdown +++ b/doc/api/fs.markdown @@ -633,9 +633,7 @@ the event. The `fs.watch` API is not 100% consistent across platforms, and is unavailable in some situations. -The recursive option is currently supported on OS X and Windows. Only FSEvents - supports this type of file watching so it is unlikely any additional platforms - will be added soon. +The recursive option is only supported on OS X and Windows. #### Availability @@ -662,11 +660,10 @@ less reliable. -Providing `filename` argument in the callback is not supported -on every platform (currently it's only supported on Linux and Windows). Even -on supported platforms `filename` is not always guaranteed to be provided. -Therefore, don't assume that `filename` argument is always provided in the -callback, and have some fallback logic if it is null. +Providing `filename` argument in the callback is only supported on Linux and +Windows. Even on supported platforms, `filename` is not always guaranteed to +be provided. Therefore, don't assume that `filename` argument is always +provided in the callback, and have some fallback logic if it is null. fs.watch('somedir', function (event, filename) { console.log('event is: ' + event);