Skip to content

Conversation

@mscdex
Copy link
Contributor

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

@mscdexmscdex 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
ContributorAuthor

/cc @nodejs/documentation

@silverwind
Copy link
Contributor

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?

@mscdexmscdexforce-pushed the doc-improve-buffer branch from c33ab18 to 977fdefCompareJuly 19, 2016 23:12
@mscdex
Copy link
ContributorAuthor

@silverwind Done.

@mscdex
Copy link
ContributorAuthor

/cc @nodejs/collaborators

Copy link
Member

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
ContributorAuthor

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

Made it about half way through tonight. Awesome work.

@mscdexmscdexforce-pushed the doc-improve-buffer branch from 977fdef to 5867219CompareJuly 20, 2016 05:51
@jasnell
Copy link
Member

Woo! LGTM

Copy link
Member

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

Thanks for the changes. LGTM

@mscdexmscdexforce-pushed the doc-improve-buffer branch from 5867219 to 8b6d7bdCompareJuly 22, 2016 21:38
mscdex added 7 commits July 22, 2016 17:41
PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
This commit adds more links and separates internal doc links from external web links. PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
This commit adds more links and reuses existing link references more. PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
@mscdexmscdexforce-pushed the doc-improve-buffer branch from 8b6d7bd to b3127dfCompareJuly 22, 2016 21:42
@mscdexmscdex merged commit b3127df into nodejs:masterJul 22, 2016
@mscdexmscdex deleted the doc-improve-buffer branch July 22, 2016 21:45
@cjihrigcjihrig mentioned this pull request Aug 8, 2016
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
This commit adds more links and separates internal doc links from external web links. PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
This commit adds more links and reuses existing link references more. PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
cjihrig pushed a commit that referenced this pull request Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trevor Norris <[email protected]>
@cjihrigcjihrig mentioned this pull request Aug 11, 2016
@MylesBorins
Copy link
Contributor

@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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bufferIssues and PRs related to the buffer subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants

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