FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add Buffer#subarray() and add note about Uint8Array#slice() by gfx · Pull Request #28101 · nodejs/node · GitHub

/ node Public

doc: add Buffer#subarray() and add note about Uint8Array#slice() - #28101

Closed
gfx wants to merge 6 commits into
nodejs:masterfrom
gfx:doc_buffer_subarray_and_slice
ConversationCommits (6)ChecksFiles changed
Closed

doc: add Buffer#subarray() and add note about Uint8Array#slice()#28101
gfx wants to merge 6 commits into
nodejs:masterfrom
gfx:doc_buffer_subarray_and_slice

Conversation

gfx commented Jun 6, 2019

Copy link
Copy Markdown
Contributor

refs: #28087

  • Added document for Buffer#subarray(); its content is just copied from #slice()
  • Changed document for Buffer#slice() because of its incompatibility with its superclass's method, and also added how to use Uint8Array.prototype.slice() to get a copy of slice
Checklist
  • [ ] 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

nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Jun 6, 2019

mscdex commented Jun 6, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor

I don't think we need to document inherited methods like subarray().

If anything, only the new note should be added to the description for slice().

gfx commented Jun 7, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@mscdex

I don't think we need to document inherited methods like subarray().

Really?

There are lots of methods and properties in the doc, directly inherited from Uint8Array, for example:

  • buf[i]
  • buf.buffer
  • buf.byteOffset
  • buf.length
  • buf.entries()
  • buf.keys()
  • buf.values()

I think #subarray() is also a method to be known, which is compatible with Uint8Array.

mscdex commented Jun 7, 2019

Copy link
Copy Markdown
Contributor

Right, I don't agree those need to be there either.

IMO there is no need to duplicate documentation (already available at places like MDN) for those properties/methods unless there is some behavioral/semantic difference with node's implementation. Making it clear that Buffer inherits from Uint8Array and providing a link to documentation for the latter should be sufficient really.

Even within node's own documentation we generally don't duplicate between similar/super objects (e.g. tls.TLSSocket does not show everything inherited from net.Socket).

sam-github commented Jun 7, 2019

Copy link
Copy Markdown
Contributor

#28101 (comment) makes sense to me. I wonder, do our docs predate Buffer being derived from Uint8Array?

mscdex commented Jun 8, 2019

Copy link
Copy Markdown
Contributor

do our docs predate Buffer being derived from Uint8Array?

Definitely.

addaleax approved these changes Jun 8, 2019
View reviewed changes

addaleax left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think it’s a good change, because it ultimately encourages using a standardized TypedArray method over our non-standard different-behaviour override of another TypedArray method.

Comment thread doc/api/buffer.md Outdated
Comment thread doc/api/buffer.md
gfx and others added 2 commits June 10, 2019 15:17
Update doc/api/buffer.md
07e7c7d 
Co-Authored-By: Anna Henningsen <github@addaleax.net>
Update doc/api/buffer.md
21e452f 
Co-Authored-By: Anna Henningsen <github@addaleax.net>

gfx commented Jun 10, 2019

Copy link
Copy Markdown
Contributor Author

Applied suggested changes!

addaleax added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Jun 10, 2019

addaleax commented Jun 10, 2019

Copy link
Copy Markdown
Member

I’ll land this tomorrow if there are no objections to that.

Trott reviewed Jun 10, 2019
View reviewed changes
Comment thread doc/api/buffer.md Outdated
Trott reviewed Jun 10, 2019
View reviewed changes
Comment thread doc/api/buffer.md Outdated
Trott reviewed Jun 10, 2019
View reviewed changes
Comment thread doc/api/buffer.md Outdated
gfx and others added 3 commits June 11, 2019 09:36
Update doc/api/buffer.md
70271da 
Co-Authored-By: Rich Trott <rtrott@gmail.com>
Update doc/api/buffer.md
eb5efd9 
Co-Authored-By: Rich Trott <rtrott@gmail.com>
Update doc/api/buffer.md
54c4949 
Co-Authored-By: Rich Trott <rtrott@gmail.com>

gfx commented Jun 11, 2019

Copy link
Copy Markdown
Contributor Author

Thanks, @Trott !

Trott commented Jun 11, 2019

Copy link
Copy Markdown
Member

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3672/

Trott commented Jun 13, 2019

Copy link
Copy Markdown
Member

Landed in ee16787

Trott closed this Jun 13, 2019
Trott pushed a commit to Trott/io.js that referenced this pull request Jun 13, 2019
doc: add Buffer#subarray() and add note about Uint8Array#slice()
ee16787 
PR-URL: nodejs#28101
Refs: nodejs#28087
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
gfx deleted the doc_buffer_subarray_and_slice branch June 13, 2019 04:01
BridgeAR pushed a commit that referenced this pull request Jun 17, 2019
doc: add Buffer#subarray() and add note about Uint8Array#slice()
8c27755 
PR-URL: #28101
Refs: #28087
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR mentioned this pull request Jun 17, 2019
Merged
bnoordhuis mentioned this pull request Jul 3, 2019
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
Trott Trott approved these changes
addaleax addaleax approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. 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

Back | FazBrowse Home | New Git URL