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: Clarify API Buffer.concat #3255

Closed
wants to merge 2 commits into from
Closed

doc: Clarify API Buffer.concat #3255

wants to merge 2 commits into from

Conversation

Martii
Copy link

@Martii Martii commented Oct 8, 2015

  • Add a simple example for buffer.concat
  • Change grammar slightly.

Fixes: #3219

doc: Clarify API Buffer.concat
19c2bb7 
Add a simple example.
Change grammar slightly.

Closes #3219
@mscdex mscdex added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Oct 8, 2015
ronkorving
ronkorving reviewed Oct 8, 2015
View reviewed changes
doc/api/buffer.markdown
@@ -127,7 +127,7 @@ Example:
### Class Method: Buffer.concat(list[, totalLength])

* `list` {Array} List of Buffer objects to concat
* `totalLength` {Number} Total length of the buffers when concatenated
* `totalLength` {Number} Total length of the buffers list when concatenated
Copy link
Contributor

Choose a reason for hiding this comment

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

But it's not the length of the list, is it? It's the total byte size of all buffers combined if I'm not mistaken.

Copy link
Author

Choose a reason for hiding this comment

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

perhaps "buffers in the list" would work better?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes it would, thanks :)

Copy link
Author

Choose a reason for hiding this comment

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

No problem. Thank you.

doc: Clarify API Buffer.concat
70e7078 
Post fix for grammar

Applies to #3255 and #3219
@jasnell
Copy link
Member

jasnell commented Oct 14, 2015

LGTM

@seishun
Copy link
Contributor

seishun commented Oct 15, 2015

I don't think an example is needed. TBH I think the current documentation is fine and the "in the list" part can be inferred.

@jasnell
Copy link
Member

jasnell commented Oct 21, 2015

@seishun ... more examples are almost never a bad thing to have in documentation.

@trevnorris
Copy link
Contributor

I'm cool w/ this. LGTM

jasnell pushed a commit that referenced this pull request Oct 22, 2015
@jasnell
doc: clarify API buffer.concat
e32aca6 
* Add a simple example for buffer.concat
* Change grammar slightly.

Fixes: #3219
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: #3255
@jasnell
Copy link
Member

jasnell commented Oct 22, 2015

Landed in e32aca6. @Martii , I fixed up the commit log just a bit to match the common style.

@jasnell jasnell closed this Oct 22, 2015
@MylesBorins
Copy link
Contributor

should this be in LTS

/cc @jasnell

@jasnell
Copy link
Member

jasnell commented Oct 23, 2015

@thealphanerd +1
On Oct 23, 2015 11:59 AM, "Myles Borins" notifications@github.com wrote:

should this be in LTS

/cc @jasnell https://github.com/jasnell

—
Reply to this email directly or view it on GitHub
#3255 (comment).

@Martii
Copy link
Author

Martii commented Oct 23, 2015

@jasnell
Thanks... mirrored it to the original GH message minus the reviewers and pr number of course... wouldn't know those on a commit. Good for future reference.

jasnell pushed a commit that referenced this pull request Oct 26, 2015
@jasnell
doc: clarify API buffer.concat
4afcf57 
* Add a simple example for buffer.concat
* Change grammar slightly.

Fixes: #3219
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: #3255
@jasnell
Copy link
Member

jasnell commented Oct 26, 2015

Landed in v4.x-staging in 4afcf57

rvagg pushed a commit that referenced this pull request Oct 26, 2015
@rvagg
doc: clarify API buffer.concat
cd245b1 
* Add a simple example for buffer.concat
* Change grammar slightly.

Fixes: #3219
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: #3255
This was referenced Oct 27, 2015
Merged
Closed
jasnell pushed a commit that referenced this pull request Oct 29, 2015
@jasnell
doc: clarify API buffer.concat
e04cb1e 
* Add a simple example for buffer.concat
* Change grammar slightly.

Fixes: #3219
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: #3255
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.
7 participants
@Martii @jasnell @seishun @trevnorris @MylesBorins @ronkorving @mscdex