Skip to content
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

Jump to bottom

doc: fix return value of write methods #5736

Closed
wants to merge 1 commit into from
Closed

doc: fix return value of write methods #5736

wants to merge 1 commit into from

Conversation

fb55
Copy link
Contributor

@fb55 fb55 commented Mar 16, 2016

See #5682

@thefourtheye thefourtheye added doc Issues and PRs related to the documentations. buffer Issues and PRs related to the buffer subsystem. labels Mar 16, 2016
@thefourtheye
Copy link
Contributor

LGTM. cc @trevnorris

mscdex
mscdex reviewed Mar 16, 2016
View reviewed changes
doc/api/buffer.markdown
@@ -1042,7 +1042,7 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 8`
* `noAssert` {Boolean} Default: false
* Return: {Number} Numbers of bytes written
* Return: {Number} The offset plus the number of written bytes
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps 'offset' should be surrounded by backticks in each of these changes since it's referencing a parameter.

@benjamingr
Copy link
Member

LGTM.

@jasnell
Copy link
Member

jasnell commented Mar 16, 2016

LGTM

jasnell pushed a commit that referenced this pull request Mar 16, 2016
@fb55 @jasnell
doc: fix return value of write methods
939d6ef 
Fixes: https:github.com//issues/5682
PR-URL: #5736
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@jasnell
Copy link
Member

jasnell commented Mar 16, 2016

Landed in 939d6ef

@jasnell jasnell closed this Mar 16, 2016
MylesBorins pushed a commit that referenced this pull request Mar 17, 2016
@fb55
doc: fix return value of write methods
9e44eb9 
Fixes: https:github.com//issues/5682
PR-URL: #5736
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
@fb55
doc: fix return value of write methods
2c82efb 
Fixes: https:github.com//issues/5682
PR-URL: #5736
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
@fb55
doc: fix return value of write methods
4332f80 
Fixes: https:github.com//issues/5682
PR-URL: #5736
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@Fishrock123 Fishrock123 mentioned this pull request Mar 22, 2016
Merged
@jasnell jasnell mentioned this pull request Mar 22, 2016
Closed
Fishrock123 pushed a commit that referenced this pull request Mar 22, 2016
@fb55 @Fishrock123
doc: fix return value of write methods
89df17e 
Fixes: https:github.com//issues/5682
PR-URL: #5736
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@fb55 @thefourtheye @benjamingr @jasnell @mscdex @MylesBorins