doc: Buffer() text copyediting by Trott · Pull Request #19567 · nodejs/node

Trott · 2018-03-23T22:21:56Z

Rewording, punctuation, consistent sentence structure and italics, wrap
section at 80 characters.

Fix run-on sentence in buffer.md

Change v6 to 6.0.0. We abandoned v-notation for versions to avoid
confusion between v8 (version 8.0.0) and V8 (the JavaScript engine).

Checklist

documentation is changed or added
commit message follows commit guidelines

Trott · 2018-03-23T22:22:26Z

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

vsemozhetbyt · 2018-03-23T22:32:31Z

doc/api/buffer.md

inadvertantly -> inadvertently?

vsemozhetbyt · 2018-03-23T22:34:53Z

doc/api/buffer.md

This line break makes the link not to be rendered properly.

Still the issue)

vsemozhetbyt · 2018-03-23T22:40:12Z

doc/api/buffer.md

unintialized -> uninitialized?

vsemozhetbyt · 2018-03-23T22:40:36Z

doc/api/buffer.md

uninitalized -> uninitialized?

vsemozhetbyt

With nits)

Trott · 2018-03-23T23:03:24Z

Guess I forgot to run the spell-check this time.....

Trott · 2018-03-23T23:35:01Z

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

trivikr · 2018-03-24T04:09:13Z

doc/api/buffer.md

nit: potentially and sensitive should be two different words?

Ditto on line 99

jasnell · 2018-03-24T14:07:37Z

doc/api/buffer.md

Please avoid you in the docs I would just strike this last sentence.

Change v6 to 6.0.0. We abandoned v-notation for versions to avoid confusion between v8 (version 8.0.0) and V8 (the JavaScript engine).

Rewording, punctuation, consistent sentence structure and italics, wrap section at 80 characters.

Trott · 2018-03-24T21:51:35Z

Nits addressed.

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

gibfahn

Is it worth saying that initialized means zero-filled?

Trott · 2018-03-26T18:45:07Z

@jasnell Is this good by you now that the word "you" is gone?

Trott · 2018-03-26T20:36:17Z

Is it worth saying that initialized means zero-filled?

Yes, except that it is not necessarily zero-filled, but filled with the value of fill which defaults to 0. I'll put that in a separate PR (so any bike-shedding on the wording doesn't delay these other changes) unless someone beats me to it.

Change v6 to 6.0.0. We abandoned v-notation for versions to avoid confusion between v8 (version 8.0.0) and V8 (the JavaScript engine). PR-URL: nodejs#19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

PR-URL: nodejs#19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Rewording, punctuation, consistent sentence structure and italics, wrap section at 80 characters. PR-URL: nodejs#19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Trott · 2018-03-26T23:20:30Z

Landed in 79fa372...d74919c

Change v6 to 6.0.0. We abandoned v-notation for versions to avoid confusion between v8 (version 8.0.0) and V8 (the JavaScript engine). PR-URL: #19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

PR-URL: #19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Rewording, punctuation, consistent sentence structure and italics, wrap section at 80 characters. PR-URL: #19567 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Mar 23, 2018

vsemozhetbyt reviewed Mar 23, 2018

View reviewed changes

doc/api/buffer.md Outdated

Copy link

Contributor

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

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

inadvertantly -> inadvertently?

vsemozhetbyt reviewed Mar 23, 2018

View reviewed changes

doc/api/buffer.md Outdated

Copy link

Contributor

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

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

unintialized -> uninitialized?

vsemozhetbyt reviewed Mar 23, 2018

View reviewed changes

doc/api/buffer.md Outdated

Copy link

Contributor

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

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

uninitalized -> uninitialized?

vsemozhetbyt approved these changes Mar 23, 2018

View reviewed changes

vsemozhetbyt added the fast-track PRs that do not need to wait for 72 hours to land. label Mar 23, 2018

Trott force-pushed the buffer-consistent-returns branch 4 times, most recently from 97692c8 to 0c8b45c Compare March 23, 2018 23:26

Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 23, 2018

trivikr approved these changes Mar 24, 2018

View reviewed changes

doc/api/buffer.md Outdated

Copy link

Member

trivikr Mar 24, 2018

Choose a reason for hiding this comment

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

nit: potentially and sensitive should be two different words?

Ditto on line 99

lpinca approved these changes Mar 24, 2018

View reviewed changes

jasnell requested changes Mar 24, 2018

View reviewed changes

doc/api/buffer.md Outdated

Copy link

Member

jasnell Mar 24, 2018

Choose a reason for hiding this comment

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

Please avoid you in the docs I would just strike this last sentence.

Trott added 3 commits March 24, 2018 14:51

doc: change v-notation for version in buffer.md

d8cda17

Change v6 to 6.0.0. We abandoned v-notation for versions to avoid confusion between v8 (version 8.0.0) and V8 (the JavaScript engine).

doc: fix run-on sentence in buffer.md

8c21272

doc: improve Buffer() text

8c184d8

Rewording, punctuation, consistent sentence structure and italics, wrap section at 80 characters.

Trott force-pushed the buffer-consistent-returns branch from 0c8b45c to 8c184d8 Compare March 24, 2018 21:51

trivikr approved these changes Mar 24, 2018

View reviewed changes

gibfahn approved these changes Mar 26, 2018

View reviewed changes

jasnell approved these changes Mar 26, 2018

View reviewed changes

Trott closed this Mar 26, 2018

Trott deleted the buffer-consistent-returns branch January 13, 2022 22:49

Uh oh!

Conversation

Trott commented Mar 23, 2018

Checklist

Uh oh!

Trott commented Mar 23, 2018

Uh oh!

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt Mar 23, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt Mar 23, 2018

Choose a reason for hiding this comment

Uh oh!

vsemozhetbyt left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Mar 23, 2018

Uh oh!

Trott commented Mar 23, 2018

Uh oh!

trivikr Mar 24, 2018

Choose a reason for hiding this comment

Uh oh!

jasnell Mar 24, 2018

Choose a reason for hiding this comment

Uh oh!

Trott commented Mar 24, 2018

Uh oh!

gibfahn left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Mar 26, 2018

Uh oh!

Trott commented Mar 26, 2018

Uh oh!

Trott commented Mar 26, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

vsemozhetbyt Mar 23, 2018 •

edited

Loading