doc: make buffer.md more accurate#27030

Closed

vsemozhetbyt wants to merge 10 commits intonodejs:masterfrom

vsemozhetbyt:doc-buffer-varia

Contributor

vsemozhetbyt commented Mar 31, 2019 •

edited

Loading

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.

Collaborator

nodejs-github-bot commented Mar 31, 2019

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

nodejs-github-bot added buffer doc labels

lpinca approved these changes

View reviewed changes

BridgeAR approved these changes

View reviewed changes

BridgeAR added the author ready label

Contributor Author

vsemozhetbyt commented Apr 2, 2019

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

vsemozhetbyt added 10 commits

April 3, 2019 00:38


          doc: remove duplication in description

e3d5d4d


          doc: fix possible typo

ac2caec


          doc: add missing types

78f629a


          doc: unify number/integer types

87d70b0


          doc: fix error notes in Buffer.from() variants

83052d2

Make notes about `TypeError` conditions in `Buffer.from()` variants
more accurate.


          doc: add note about Buffer octets integer coercion

142009e


          doc: mark optional parameters

8b49feb


          doc: add notes about negative offsets

213fed4


          doc: unify periods in comments

fbf4c70

"Prints: ..." comments were excepted to avoid confusion.


          doc: unify link formatting

56da51a

Contributor Author

vsemozhetbyt commented Apr 2, 2019

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

vsemozhetbyt added a commit that referenced this pull request


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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>

Contributor Author

vsemozhetbyt commented Apr 2, 2019

Landed in 4d27394...7aa7971

Thank you for the reviews.

vsemozhetbyt closed this

BethGriggs pushed a commit that referenced this pull request


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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 mentioned this pull request

v11.14.0 proposal #27163

Merged

BethGriggs pushed a commit that referenced this pull request


          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


          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


          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


          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


          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


          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


          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


          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


          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


          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

Labels

author ready buffer doc