Skip to content

Commit

Permalink
docs: fs - remove encoding list and link to buffer
Browse files Browse the repository at this point in the history
  • Loading branch information
@jasnell
fansworld-claudio authored and jasnell committed Nov 5, 2015
1 parent 8625a38 commit 2e38079
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions doc/api/fs.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -828,7 +828,7 @@ default value of 64 kb for the same parameter.

`options` can include `start` and `end` values to read a range of bytes from
the file instead of the entire file. Both `start` and `end` are inclusive and
start at 0. The `encoding` can be `'utf8'`, `'ascii'`, or `'base64'`.
start at 0. The `encoding` can be any one of those accepted by [Buffer](buffer.html).

If `fd` is specified, `ReadStream` will ignore the `path` argument and will use
the specified file descriptor. This means that no `open` event will be emitted.
Expand Down Expand Up @@ -873,8 +873,7 @@ Returns a new WriteStream object (See `Writable Stream`).
`options` may also include a `start` option to allow writing data at
some position past the beginning of the file. Modifying a file rather
than replacing it may require a `flags` mode of `r+` rather than the
default mode `w`. The `defaultEncoding` can be `'utf8'`, `'ascii'`, `binary`,
or `'base64'`.
default mode `w`. The `defaultEncoding` can be any one of those accepted by [Buffer](buffer.html).

Like `ReadStream` above, if `fd` is specified, `WriteStream` will ignore the
`path` argument and will use the specified file descriptor. This means that no
Expand Down

6 comments on commit 2e38079

@rvagg
Copy link
Member

@rvagg rvagg commented on 2e38079 Nov 6, 2015

Choose a reason for hiding this comment

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

Second commit in #2796 but landed without metadata, @jasnell don't forget to amend all the commits in a PR

@jasnell
Copy link
Member

@jasnell jasnell commented on 2e38079 Nov 6, 2015 via email

Choose a reason for hiding this comment

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

@jasnell
Copy link
Member

@jasnell jasnell commented on 2e38079 Nov 6, 2015 via email

Choose a reason for hiding this comment

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

@MylesBorins
Copy link
Contributor

Choose a reason for hiding this comment

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

For reference this commit should not land on v4.x

@rvagg do you think there is a way we could add something to branch-diff to allow most release comments on the commit flag it to be ignored?

@rvagg
Copy link
Member

@rvagg rvagg commented on 2e38079 Jul 13, 2016

Choose a reason for hiding this comment

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

@thealphanerd sorry I'm just catching up on old notifications now (there's a huge batch around April that I'm still working through!)

Can you clarify this request for branch-diff? Perhaps it's been fixed with --filter-release?

@MylesBorins
Copy link
Contributor

Choose a reason for hiding this comment

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

@rvagg I think the idea was to find a way to make commits ignorable based on a comment in the cases where a PR-URL is unavailable or it is not easy to set a flag (in the case of a PR-URL pointing at npm for example)

Please sign in to comment.