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

doc: improve child_process `maxBuffer` text by Trott · Pull Request #11791 · nodejs/node · GitHub

/ node Public

doc: improve child_process maxBuffer text - #11791

Closed
Trott wants to merge 1 commit into
nodejs:masterfrom
Trott:maxbuffer-edit
ConversationCommits (1)ChecksFiles changed
Closed

doc: improve child_process maxBuffer text#11791
Trott wants to merge 1 commit into
nodejs:masterfrom
Trott:maxbuffer-edit

Conversation

Trott commented Mar 10, 2017

Copy link
Copy Markdown
Member

maxBuffer information in child_process.md used atypical formatting.
This uses a single consistent style for all instances of maxBuffer
information.

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc child_process

Trott added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Mar 10, 2017
nodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Mar 10, 2017
addaleax approved these changes Mar 10, 2017
View reviewed changes
Comment thread doc/api/child_process.md Outdated

addaleax Mar 10, 2017

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

typo: exceede

Trott Mar 10, 2017

Copy link
Copy Markdown
Member Author

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

Fixed, thanks!

Trott commented Mar 10, 2017 •
edited
Loading

Copy link
Copy Markdown
Member Author

A key thing this fixes is the confusing alternate formatting for maxBuffer in the doc which you can see here:

Because it's a link, maxBuffer is formatted differently than shell, timeout, uid, gid...

The link isn't to full information about maxBuffer so it's a bit misleading. It's a special note about maxBuffer and Unicode. So this PR moves the link out of that list and into the descriptive text, and makes it clear that it's a note and not key information. The note basically reminds people that a character can be more than one byte.

doc: improve child_process maxBuffer text
5031022 
`maxBuffer` information in child_process.md used atypical formatting.
This uses a single consistent style for all instances of `maxBuffer`
information.
Trott added a commit to Trott/io.js that referenced this pull request Mar 13, 2017
doc: improve child_process maxBuffer text
ea5a2f4 
`maxBuffer` information in child_process.md used atypical formatting.
This uses a single consistent style for all instances of `maxBuffer`
information.

PR-URL: nodejs#11791
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Trott commented Mar 13, 2017

Copy link
Copy Markdown
Member Author

Landed in ea5a2f4

Trott closed this Mar 13, 2017
italoacasas pushed a commit to italoacasas/node that referenced this pull request Mar 14, 2017
doc: improve child_process maxBuffer text
6cc7b30 
`maxBuffer` information in child_process.md used atypical formatting.
This uses a single consistent style for all instances of `maxBuffer`
information.

PR-URL: nodejs#11791
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas mentioned this pull request Mar 14, 2017
Merged
jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017
doc: improve child_process maxBuffer text
a624472 
`maxBuffer` information in child_process.md used atypical formatting.
This uses a single consistent style for all instances of `maxBuffer`
information.

PR-URL: nodejs#11791
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins commented Apr 17, 2017

Copy link
Copy Markdown
Contributor

is this applicable to v6.x?

Trott commented Apr 18, 2017

Copy link
Copy Markdown
Member Author

@MylesBorins It's a style change, not a content change, so I think the answer is "yes, but it's also not crucial by any stretch".

koh110 mentioned this pull request Oct 22, 2018
Closed
4 tasks
Trott deleted the maxbuffer-edit branch January 13, 2022 22:45
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
addaleax addaleax approved these changes
lpinca lpinca approved these changes
cjihrig cjihrig approved these changes

Assignees

No one assigned

Labels

child_process Issues and PRs related to the child_process 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