doc: fix sentence fragment in fs doc - #6488
Conversation
Sorry, something went wrong.
|
|
||
| _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/
Sorry, something went wrong.
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.
Sorry, something went wrong.
There was a problem hiding this comment.
either way works for me.
Sorry, something went wrong.
|
small nit, but LGTM |
Sorry, something went wrong.
|
LGTM |
Sorry, something went wrong.
|
LGTM |
Sorry, something went wrong.
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>
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>
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>
Checklist
Affected core subsystem(s)
doc
Description of change
Edit a sentence fragment so that it is a complete sentence.