Skip to content

doc: copyedit fs doc - #3097

Closed
Trott wants to merge 2 commits into
nodejs:masterfrom
Trott:doc-fs
Closed

doc: copyedit fs doc#3097
Trott wants to merge 2 commits into
nodejs:masterfrom
Trott:doc-fs

Conversation

@Trott

@TrottTrott commented Sep 28, 2015

Copy link
Copy Markdown
Member

Minor editing for clarity and concision.

@TrottTrott added the doc Issues and PRs related to the documentations. label Sep 28, 2015
@thefourtheye

thefourtheye commented Sep 28, 2015

Copy link
Copy Markdown
Contributor

Recursive support for Windows has been added only recently and I assume this is going to be an ongoing process. So, we may not require that change.

cc @saghul

@Trott

Trott commented Sep 28, 2015

Copy link
Copy Markdown
MemberAuthor

@thefourtheye I'm not sure I understand what you mean. The only change I'm proposing for that part of the doc is to change currently supported on OS X and Windows to only supported on OS X and Windows. I think that's an improvement because:

  • The word currently is superfluous. Whatever you put in the documentation, it is assumed to be the current state of the API.
  • The word only makes it explicit that it is not supported anywhere else. Leaving out only makes it ambiguous. Is it supported on OS X and Windows as well as other platforms? Or just those two platforms and nowhere else?

Am I misunderstanding something?

@thefourtheye

thefourtheye commented Sep 28, 2015

Copy link
Copy Markdown
Contributor

Hmmm okay. LGTM then

@targos

targos commented Sep 28, 2015

Copy link
Copy Markdown
Member

LGTM

@saghul

saghul commented Sep 28, 2015

Copy link
Copy Markdown
Member

IMHO it can be trimmed further.

"Only FSEvents supports this type of file watching so it is unlikely any additional platforms will be added soon."

Here "FSEvents" refers to the OSX API, but since we added Windows support I don't think we should say it's unlikely that we add more.

@Trott
doc: further copyediting to fs doc
a921dc9
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.
@Trott

Trott commented Sep 28, 2015

Copy link
Copy Markdown
MemberAuthor

@saghul OK, trimmed further. Thanks. How's it look now? /cc @thefourtheye@targos

@thefourtheye

thefourtheye commented Sep 28, 2015

Copy link
Copy Markdown
Contributor

LGTM

2 similar comments
@targos

targos commented Sep 28, 2015

Copy link
Copy Markdown
Member

LGTM

@saghul

saghul commented Sep 28, 2015

Copy link
Copy Markdown
Member

LGTM

Trott added a commit to Trott/io.js that referenced this pull request Sep 30, 2015
@Trott
doc: copyedit fs.watch() information
0e4b772
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: nodejs#3097
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
@Trott

Trott commented Sep 30, 2015

Copy link
Copy Markdown
MemberAuthor

Landed in 0e4b772

@TrottTrott closed this Sep 30, 2015
Trott added a commit that referenced this pull request Oct 2, 2015
@Trott@rvagg
doc: copyedit fs.watch() information
928166c
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: #3097
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
@rvaggrvagg mentioned this pull request Oct 3, 2015
Closed
@Trott
Trott deleted the doc-fs branch January 13, 2022 22:28
@alisccoaliscco mentioned this pull request Jun 22, 2023
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Trott@thefourtheye@targos@saghul