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.

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

doc: Typo in buffer.markdown referencing buf.write() #4324

Closed
wants to merge 1 commit into from

Conversation

chrisJohn404
Copy link
Contributor

The buffer's write function is documented below the buffer.toString function. The final sentence describing the toString function indicated that there was a buffer.write function documented above it. Additionally, all of the docs for buffer now use "buf" so the code snippet was changed to "buf.write()".

The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".
@mscdex mscdex added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Dec 17, 2015
@chrisJohn404 chrisJohn404 changed the title docs: Typo in buffer.markdown referencing buf.write() doc: Typo in buffer.markdown referencing buf.write() Dec 17, 2015
@jasnell
Copy link
Member

jasnell commented Dec 17, 2015

LGTM

jasnell pushed a commit that referenced this pull request Dec 17, 2015
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".

PR-URL: #4324
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell
Copy link
Member

jasnell commented Dec 17, 2015

Landed in f2bddc1

@jasnell jasnell closed this Dec 17, 2015
@jasnell jasnell mentioned this pull request Dec 17, 2015
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Dec 22, 2015
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".

PR-URL: nodejs#4324
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 30, 2015
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".

PR-URL: #4324
Reviewed-By: James M Snell <jasnell@gmail.com>
@rvagg
Copy link
Member

rvagg commented Jan 4, 2016

Thanks for this @chrisJohn404, I believe this is your first commit to core and even though the change is trivial we appreciate the attention to detail, our docs have been improving rapidly thanks to people like yourself willing to go to the effort when they see something wrong. Welcome on board, we hope you stick around and can find other ways to contribute.

Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Jan 6, 2016
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".

PR-URL: nodejs#4324
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Jan 19, 2016
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".

PR-URL: #4324
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Jan 19, 2016
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".

PR-URL: nodejs#4324
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants