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.

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: make buffer.md more accurate #27030

Closed
wants to merge 10 commits into from
Closed

doc: make buffer.md more accurate #27030

wants to merge 10 commits into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented Mar 31, 2019 •
edited

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

It may be easier to review the changes commit by commit, where they are grouped by a category. Last two commits are the biggest, but also easily skimmable.

  • Remove duplication in a description.
  • Fix possible typo.
  • Add missing types.
  • Unify number/integer types.
  • Make notes about TypeError conditions in Buffer.from() variants more accurate.
  • Add a general note about integer coercion for Buffer octets.
  • Mark optional parameters as optional.
  • Add notes about negative offsets.
  • Unify periods in comments (except "Prints: ..." comments to avoid confusion).
  • Unify link formatting.

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Mar 31, 2019
@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 1, 2019
@vsemozhetbyt
Copy link
Contributor Author

Common and 3-way merges fail. Trying to rebase and retry...

@vsemozhetbyt
Copy link
Contributor Author

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

vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: remove description duplication in buffer.md
1dd9662 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: fix possible typo in buffer.md
f89568e 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: add missing types in buffer.md
3c11f64 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: unify number/integer types in buffer.md
2f338f3 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: fix error notes in Buffer.from() variants
e4c6c3b 
Make notes about `TypeError` conditions in `Buffer.from()` variants
more accurate.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: add note about Buffer octets integer coercion
0e803d1 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: mark optional parameters in buffer.md
82a95fe 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: add notes about negative offsets in buffer.md
2de6734 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: unify periods in comments in buffer.md
35d83d5 
"Prints: ..." comments were excepted to avoid confusion.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
vsemozhetbyt added a commit that referenced this pull request Apr 2, 2019
@vsemozhetbyt
doc: unify link formatting in buffer.md
7aa7971 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@vsemozhetbyt
Copy link
Contributor Author

Landed in 4d27394...7aa7971

Thank you for the reviews.

BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: fix possible typo in buffer.md
d112a32 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: add missing types in buffer.md
7e24782 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: unify number/integer types in buffer.md
a65a1ab 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: fix error notes in Buffer.from() variants
e810a52 
Make notes about `TypeError` conditions in `Buffer.from()` variants
more accurate.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: add note about Buffer octets integer coercion
6942a18 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: mark optional parameters in buffer.md
358faf4 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: add notes about negative offsets in buffer.md
562e53a 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: unify periods in comments in buffer.md
1bbdb0d 
"Prints: ..." comments were excepted to avoid confusion.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: unify link formatting in buffer.md
d0f9efd 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: remove description duplication in buffer.md
f475e79 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: fix possible typo in buffer.md
231eff9 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: add missing types in buffer.md
0d75adc 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: unify number/integer types in buffer.md
e18a0e8 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: fix error notes in Buffer.from() variants
c3d573d 
Make notes about `TypeError` conditions in `Buffer.from()` variants
more accurate.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: add note about Buffer octets integer coercion
eeee636 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: mark optional parameters in buffer.md
3567ff1 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: add notes about negative offsets in buffer.md
5983cef 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: unify periods in comments in buffer.md
6e3b6c5 
"Prints: ..." comments were excepted to avoid confusion.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 9, 2019
@vsemozhetbyt @BethGriggs
doc: unify link formatting in buffer.md
2d780f8 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
@BethGriggs BethGriggs mentioned this pull request Apr 9, 2019
Merged
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: remove description duplication in buffer.md
5fdee11 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: fix possible typo in buffer.md
fd3b031 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: add missing types in buffer.md
944ce7b 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: unify number/integer types in buffer.md
5fd4053 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: fix error notes in Buffer.from() variants
3a35d8a 
Make notes about `TypeError` conditions in `Buffer.from()` variants
more accurate.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: add note about Buffer octets integer coercion
f9ef9eb 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: mark optional parameters in buffer.md
ea75d43 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: add notes about negative offsets in buffer.md
19ccee0 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: unify periods in comments in buffer.md
221bcfb 
"Prints: ..." comments were excepted to avoid confusion.

PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
BethGriggs pushed a commit that referenced this pull request Apr 10, 2019
@vsemozhetbyt @BethGriggs
doc: unify link formatting in buffer.md
00eef26 
PR-URL: #27030
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, 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.

None yet
4 participants
@vsemozhetbyt @nodejs-github-bot @lpinca @BridgeAR