doc: wrap buffer.md at 80 characters #19546

Trott · 2018-03-23T05:34:36Z

Wrap buffer.md at 80 characters and enforce with linter.

Checklist

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

Trott · 2018-03-23T05:58:31Z

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

apapirovski · 2018-03-23T14:05:30Z

ping @mcollina given the objections last time this came up.

mcollina · 2018-03-23T14:19:00Z

I'm still -1 for the time being on this. Happy for this go to a TSC vote if you feel strongly about it, this has been discussed extensively already and not linting this file was the middle ground that was reached. See the long discussion in #18726.

Thanks @apapirovski for the ping.

mcollina

making my -1 prominent

Trott · 2018-03-23T18:21:03Z

@mcollina Your opposition is based on the fact that the whitespace changes will complicate backporting? Or are there other concerns too?

mcollina · 2018-03-23T19:43:48Z

I’m generically -1 on massive linting changes if I get the chance to review them. Regarding this specifically, yes it is a backport problem.

Trott · 2018-03-23T20:19:50Z

Regarding this specifically, yes it is a backport problem.

If I open backport PRs right now for 9.x, 8.x, and 6.x, would that be enough to remove your objection? Or is the churn here still just too much?

mcollina · 2018-03-23T20:36:24Z

IMHO it is too much churn.
However I see that I should have pushed back way more strongly when the rule was introduced (and brought it to the TSC then). At this point this can land. There is a overwhelming response that this is wanted.

BridgeAR · 2018-03-24T11:47:01Z

@Trott if I understood @mcollina correct he is actually OK with landing this because there are a lot of +1 on this. Can you verify that again @mcollina?

mcollina · 2018-03-24T12:09:48Z

As I said, I should have brought the matter to the TSC back then. Anyway, feel free to land.

Trott · 2018-03-24T21:14:31Z

There's changes in here that break links. Still need to address those. So please don't land. I'll add the in progress label.

gibfahn · 2018-03-26T08:24:08Z

doc/api/buffer.md

+* [`Buffer.from(array)`] returns a new `Buffer` containing a *copy* of the
+  provided octets.
+* [`Buffer.from(arrayBuffer[, byteOffset [, length]])`]
+  [`Buffer.from(arrayBuffer)`] returns a new `Buffer` that *shares* the same


@Trott I could be wrong, but I think the broken links can be fixed by moving the opening [ up to the previous line.

Trott · 2018-03-30T13:45:32Z

@Trott is this is WIP?

@BridgeAR Yes. I have some smaller PRs against this file open that I want to land first.

(If having it remain open for a bit longer is problematic, it can be closed. I can always re-open it when it's ready.)

Dismissing to indicate that it is fine to land this PR as mentioned in a former comment.

BridgeAR · 2018-04-09T17:32:16Z

Ping @Trott

Trott · 2018-04-09T18:48:57Z

@BridgeAR Working through this slowly and opening other PRs when I find bigger issues that need addressing near one of these line-wraps. As I rebase, the change set gets smaller and smaller, which I think is A Good Thing. If having this open is a problem, feel free to close it. Otherwise, it's mildly convenient for me and it will land eventually, just not this week.

Trott · 2018-04-20T04:05:45Z

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

Wrap `buffer.md` at 80 characters and enforce with linter.

Trott · 2018-04-20T04:09:35Z

Lite CI: https://ci.nodejs.org/job/node-test-commit-lite/724/

Wrap `buffer.md` at 80 characters and enforce with linter. PR-URL: nodejs#19546 Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Trott · 2018-04-20T17:45:05Z

Landed in 743341d

Wrap `buffer.md` at 80 characters and enforce with linter. PR-URL: #19546 Reviewed-By: Yuta Hiroto <hello@hiroppy.me> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@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

hiroppy approved these changes Mar 23, 2018

View reviewed changes

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

danbev approved these changes Mar 23, 2018

View reviewed changes

tniessen approved these changes Mar 23, 2018

View reviewed changes

lpinca approved these changes Mar 23, 2018

View reviewed changes

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

vsemozhetbyt approved these changes Mar 23, 2018

View reviewed changes

cjihrig approved these changes Mar 23, 2018

View reviewed changes

mcollina removed the fast-track PRs that do not need to wait for 48 hours to land. label Mar 23, 2018

mcollina previously requested changes Mar 23, 2018

View reviewed changes

jasnell approved these changes Mar 23, 2018

View reviewed changes

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

Trott added the wip Issues and PRs that are still a work in progress. label Mar 24, 2018

Trott force-pushed the max-line branch from 247ff44 to 87d33d8 Compare March 24, 2018 22:36

gibfahn approved these changes Mar 26, 2018

View reviewed changes

gibfahn reviewed Mar 26, 2018

View reviewed changes

Trott force-pushed the max-line branch 2 times, most recently from 66c9e5d to fa7b2c3 Compare March 26, 2018 23:24

Trott force-pushed the max-line branch 7 times, most recently from d425e0d to ec7b5a7 Compare April 7, 2018 04:13

Trott force-pushed the max-line branch from ec7b5a7 to 34ee5d3 Compare April 9, 2018 18:46

Trott force-pushed the max-line branch 4 times, most recently from 94cb561 to 18e5b0c Compare April 14, 2018 21:30

Trott force-pushed the max-line branch 3 times, most recently from a54da8e to c6ef2a2 Compare April 20, 2018 04:04

Trott removed the wip Issues and PRs that are still a work in progress. label Apr 20, 2018

Trott changed the title ~~doc: wrap buffer.md at 80 characaters~~ doc: wrap buffer.md at 80 characters Apr 20, 2018

doc: wrap buffer.md at 80 characters

7373b7d

Wrap `buffer.md` at 80 characters and enforce with linter.

Trott force-pushed the max-line branch from c6ef2a2 to 7373b7d Compare April 20, 2018 04:07

Trott closed this Apr 20, 2018

Trott deleted the max-line branch January 13, 2022 22:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: wrap buffer.md at 80 characters #19546

doc: wrap buffer.md at 80 characters #19546

Trott commented Mar 23, 2018

Trott commented Mar 23, 2018

apapirovski commented Mar 23, 2018

mcollina commented Mar 23, 2018

mcollina left a comment

Trott commented Mar 23, 2018

mcollina commented Mar 23, 2018

Trott commented Mar 23, 2018

mcollina commented Mar 23, 2018

BridgeAR commented Mar 24, 2018

mcollina commented Mar 24, 2018

Trott commented Mar 24, 2018

gibfahn Mar 26, 2018

Trott commented Mar 30, 2018

BridgeAR commented Apr 9, 2018

Trott commented Apr 9, 2018

Trott commented Apr 20, 2018

Trott commented Apr 20, 2018

Trott commented Apr 20, 2018

doc: wrap buffer.md at 80 characters #19546

doc: wrap buffer.md at 80 characters #19546

Conversation

Trott commented Mar 23, 2018

Checklist

Trott commented Mar 23, 2018

apapirovski commented Mar 23, 2018

mcollina commented Mar 23, 2018

mcollina left a comment

Choose a reason for hiding this comment

Trott commented Mar 23, 2018

mcollina commented Mar 23, 2018

Trott commented Mar 23, 2018

mcollina commented Mar 23, 2018

BridgeAR commented Mar 24, 2018

mcollina commented Mar 24, 2018

Trott commented Mar 24, 2018

gibfahn Mar 26, 2018

Choose a reason for hiding this comment

Trott commented Mar 30, 2018

BridgeAR commented Apr 9, 2018

Trott commented Apr 9, 2018

Trott commented Apr 20, 2018

Trott commented Apr 20, 2018

Trott commented Apr 20, 2018