Skip to content

doc: fix sentence fragment in fs doc #6488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: fix sentence fragment in fs doc #6488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
returned._
will return an error. In contrast, on Windows and FreeBSD, a file descriptor
Copy link
Member

@jasnell jasnell Apr 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just s/error. Whereas/error, whereas/

Copy link
Member Author

@Trott Trott Apr 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@jasnell jasnell Apr 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

either way works for me.

will be returned._

```js
// OS X and Linux
Expand Down