Skip to content

doc: make general improvements to Buffer docs#7784

Merged
mscdex merged 7 commits intonodejs:masterfrom
mscdex:doc-improve-buffer
Jul 22, 2016
Merged

doc: make general improvements to Buffer docs#7784
mscdex merged 7 commits intonodejs:masterfrom
mscdex:doc-improve-buffer

Conversation

@mscdex
Copy link
Contributor

@mscdex mscdex commented Jul 18, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
  • doc
Description of change
  • Fix existing metadata and add new metadata
  • Reorganize and add more link references
  • Better consistency in wording, code examples, and coding style
  • Make default function parameter values more easily visible
  • Fill in more function parameter and return value descriptions

@mscdex mscdex added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Jul 18, 2016
@mscdex
Copy link
Contributor Author

mscdex commented Jul 18, 2016

/cc @nodejs/documentation

@silverwind
Copy link
Contributor

silverwind commented Jul 19, 2016

1,150 additions, 770 deletions not shown because the diff is too large.

Darn you, GitHub. @mscdex would you mind splitting up in two or more logical commits so we can do inline review?

@mscdex mscdex force-pushed the doc-improve-buffer branch from c33ab18 to 977fdef Compare July 19, 2016 23:12
@mscdex
Copy link
Contributor Author

mscdex commented Jul 19, 2016

@silverwind Done.

@mscdex
Copy link
Contributor Author

mscdex commented Jul 20, 2016

/cc @nodejs/collaborators

addaleax
addaleax reviewed Jul 20, 2016
View reviewed changes
doc/api/buffer.md Outdated
Copy link
Member

@addaleax addaleax Jul 20, 2016

Choose a reason for hiding this comment

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

nit: space before the link

Copy link
Contributor Author

@mscdex mscdex Jul 20, 2016

Choose a reason for hiding this comment

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

Fixed

@trevnorris
Copy link
Contributor

trevnorris commented Jul 20, 2016

Made it about half way through tonight. Awesome work.

@mscdex mscdex force-pushed the doc-improve-buffer branch from 977fdef to 5867219 Compare July 20, 2016 05:51
@jasnell
Copy link
Member

jasnell commented Jul 20, 2016

Woo! LGTM

RReverser
RReverser reviewed Jul 20, 2016
View reviewed changes
doc/api/buffer.md Outdated
Copy link
Member

@RReverser RReverser Jul 20, 2016

Choose a reason for hiding this comment

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

Do we really want this "floor of ... divided by two" here? Looks like condition doesn't change if we remove it, Buffer.poolSize >> 1 is rather computation optimization than something users should be aware of.

For example, if Buffer.poolSize would be equal to 3, both conditions size is less than or equal to Buffer.poolSize >> 1 (floor of Buffer.poolSize divided by two) (size <= 1) and size is less than or equal to Buffer.poolSize divided by two (size <= 1.5) are equal for any integer size.

Or do we explicitly want to specify behavior for cases when floating number is passed as a size?

@trevnorris
Copy link
Contributor

trevnorris commented Jul 20, 2016

Thanks for the changes. LGTM

@mscdex mscdex force-pushed the doc-improve-buffer branch from 5867219 to 8b6d7bd Compare July 22, 2016 21:38
mscdex added 7 commits July 22, 2016 17:41
@mscdex
doc: improve Buffer code examples
fe89848 
PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex
doc: reorganize Buffer link references
344cac1 
This commit adds more links and separates internal doc links
from external web links.

PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex
doc: improve links in Buffer docs
cc1318b 
This commit adds more links and reuses existing link references more.

PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex
doc: improve wording and style of Buffer docs
87a097d 
PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex
doc: add missing properties in Buffer docs
3f208c7 
PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex
doc: improve function parameter descriptions
ac57089 
PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex
doc: add/fix version metadata for Buffer methods
b3127df 
PR-URL: nodejs#7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex mscdex force-pushed the doc-improve-buffer branch from 8b6d7bd to b3127df Compare July 22, 2016 21:42
@mscdex mscdex merged commit b3127df into nodejs:master Jul 22, 2016
@mscdex mscdex deleted the doc-improve-buffer branch July 22, 2016 21:45
@cjihrig cjihrig mentioned this pull request Aug 8, 2016
Closed
@addaleax addaleax mentioned this pull request Aug 9, 2016
Merged
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: improve Buffer code examples
17ae49a 
PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: reorganize Buffer link references
0103d9d 
This commit adds more links and separates internal doc links
from external web links.

PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: improve links in Buffer docs
9a4a00b 
This commit adds more links and reuses existing link references more.

PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: improve wording and style of Buffer docs
a8e7c7f 
PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: add missing properties in Buffer docs
bdc8690 
PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: improve function parameter descriptions
49a669b 
PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
@mscdex @cjihrig
doc: add/fix version metadata for Buffer methods
57fb0d2 
PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@cjihrig cjihrig mentioned this pull request Aug 11, 2016
Merged
@MylesBorins
Copy link
Contributor

MylesBorins commented Sep 30, 2016

@mscdex I'm going to pass on landing this due to it being such a big change, and not being 100% if it aligns to the v4.x implementation of buffer. Please feel free to backport

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.

9 participants

@mscdex @silverwind @trevnorris @jasnell @MylesBorins @rmg @ChALkeR @RReverser @addaleax