doc: improve child_process maxBuffer text
#11791
Closed
Conversation
This file contains 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
Trott
added
child_process
nodejs-github-bot
added
child_process
addaleax
approved these changes
Mar 10, 2017
doc/api/child_process.md
Outdated
| * [`maxBuffer`][] {number} largest amount of data (in bytes) allowed on | ||
| stdout or stderr - if exceeded child process is killed (Default: `200*1024`) | ||
| * `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or | ||
| stderr. (Default: `200*1024`) If exceede, the child process is terminated. |
|
A key thing this fixes is the confusing alternate formatting for
Because it's a link, The link isn't to full information about |
`maxBuffer` information in child_process.md used atypical formatting. This uses a single consistent style for all instances of `maxBuffer` information.
cjihrig
approved these changes
Mar 10, 2017
lpinca
approved these changes
Mar 11, 2017
jasnell
approved these changes
Mar 11, 2017
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Mar 13, 2017
`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>
|
Landed in ea5a2f4 |
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Mar 14, 2017
`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>
jungx098
pushed a commit
to jungx098/node
that referenced
this pull request
Mar 21, 2017
`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>
|
is this applicable to v6.x? |
|
@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". |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
maxBufferinformation in child_process.md used atypical formatting.This uses a single consistent style for all instances of
maxBufferinformation.
Checklist
Affected core subsystem(s)
doc child_process