doc: fix sentence fragment in fs doc #6488
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -797,8 +797,8 @@ the end of the file. | |||
|
|
|||
| _Note: The behavior of `fs.open()` is platform specific for some flags. As such, | |||
| opening a directory on OS X and Linux with the `'a+'` flag - see example below - | |||
| will return an error. Whereas on Windows and FreeBSD a file descriptor will be | |||
There was a problem hiding this comment.
I'd just s/error. Whereas/error, whereas/
There was a problem hiding this comment.
I considered that, but then you have a fairly long sentence that is probably harder to understand than the two separate sentences:
As such, opening a directory on OS X and Linux with the
'a+'flag - see example below - will return an error, whereas on Windows and FreeBSD a file descriptor will be returned.
I could be persuaded, but I do prefer splitting that into two sentences. The see example below in the middle of the long sentence is especially kind of begging for a shorter sentence.
|
small nit, but LGTM |
|
LGTM |
|
LGTM |
jasnell
pushed a commit
that referenced
this pull request
May 1, 2016
PR-URL: #6488 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Alexander Makarenko <estliberitas@gmail.com>
|
Landed in 9f8d0ea |
Fishrock123
pushed a commit
that referenced
this pull request
May 4, 2016
PR-URL: #6488 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Alexander Makarenko <estliberitas@gmail.com>
This was referenced May 4, 2016
joelostrowski
pushed a commit
to joelostrowski/node
that referenced
this pull request
May 4, 2016
PR-URL: nodejs#6488 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Alexander Makarenko <estliberitas@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc
Description of change
Edit a sentence fragment so that it is a complete sentence.