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

Add SharedArrayBuffer to Buffer documentation #15489

Closed
wants to merge 5 commits into
base: master
from

Conversation

@ThomasdenH
Contributor

ThomasdenH commented Sep 20, 2017

Since 2a2ec9d, Buffer accepts a SharedArrayBuffer in places where ArrayBuffer was accepted previously. This PR updates the documentation accordingly.

Note that not every occurrence was replaced. In most cases it seems clear from the context that both are accepted, although some might disagree about this.

  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Show outdated Hide outdated doc/api/buffer.md Outdated
@ThomasdenH

This comment has been minimized.

Show comment
Hide comment
@ThomasdenH

ThomasdenH Sep 20, 2017

Contributor

Done. I can rebase the commits if you prefer.

Contributor

ThomasdenH commented Sep 20, 2017

Done. I can rebase the commits if you prefer.

@lpinca

This comment has been minimized.

Show comment
Hide comment
@lpinca

lpinca Sep 20, 2017

Member

No, it's fine, commits are squashed before landing. Thank you.

Member

lpinca commented Sep 20, 2017

No, it's fine, commits are squashed before landing. Thank you.

Show outdated Hide outdated doc/api/buffer.md Outdated
When `string` is a `Buffer`/[`DataView`]/[`TypedArray`]/[`ArrayBuffer`], the
actual byte length is returned.
When `string` is a `Buffer`/[`DataView`]/[`TypedArray`]/[`ArrayBuffer`]/
[`SharedArrayBuffer`], the actual byte length is returned.

This comment has been minimized.

@TimothyGu

TimothyGu Sep 20, 2017

Member

Ditto.

@TimothyGu

TimothyGu Sep 20, 2017

Member

Ditto.

Show outdated Hide outdated doc/api/buffer.md Outdated
@BridgeAR

LGTM with the comments addressed.

@ThomasdenH

This comment has been minimized.

Show comment
Hide comment
@ThomasdenH

ThomasdenH Sep 24, 2017

Contributor

I've addressed the comments.

Contributor

ThomasdenH commented Sep 24, 2017

I've addressed the comments.

Show outdated Hide outdated doc/api/buffer.md Outdated
Show outdated Hide outdated doc/api/buffer.md Outdated
Show outdated Hide outdated doc/api/buffer.md Outdated
@BridgeAR

This comment has been minimized.

Show comment
Hide comment
@BridgeAR

BridgeAR Oct 1, 2017

Member

Ping @ThomasdenH this needs a rebase and please address the comments about the line length.

Member

BridgeAR commented Oct 1, 2017

Ping @ThomasdenH this needs a rebase and please address the comments about the line length.

@BridgeAR

This comment has been minimized.

Show comment
Hide comment
@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Nov 22, 2017

Member

@ThomasdenH ... can I ask you to please squash the commits down into a single commit

Member

jasnell commented Nov 22, 2017

@ThomasdenH ... can I ask you to please squash the commits down into a single commit

@targos

This comment has been minimized.

Show comment
Hide comment
@targos
Member

targos commented Nov 23, 2017

Linter CI after rebase and squash: https://ci.nodejs.org/job/node-test-linter/13860/

Edit: CI timed out. New try: https://ci.nodejs.org/job/node-test-linter/13861/

@targos

targos approved these changes Nov 23, 2017

@targos

This comment has been minimized.

Show comment
Hide comment
@targos

targos Nov 23, 2017

Member

Landed in bd0e36d

Member

targos commented Nov 23, 2017

Landed in bd0e36d

@targos targos closed this Nov 23, 2017

targos added a commit that referenced this pull request Nov 23, 2017

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: #15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

@addaleax addaleax removed the author ready label Nov 28, 2017

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: #15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: #15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

@MylesBorins MylesBorins referenced this pull request Dec 12, 2017

Merged

v9.3.0 proposal #17631

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: #15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: #15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Closed

v8.9.4 proposal #17772

gibfahn added a commit that referenced this pull request Dec 20, 2017

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: #15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Merged

v8.9.4 proposal #17774

@MylesBorins MylesBorins referenced this pull request Dec 20, 2017

Merged

v6.12.3 proposal #17776

msoechting added a commit to hpicgs/node that referenced this pull request Feb 5, 2018

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: nodejs#15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: add SharedArrayBuffer to Buffer documentation
PR-URL: nodejs#15489
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment