[v6.x backport] doc: standardize function param/object prop style#16560
Closed
matejkrajcovic wants to merge 3 commits into
Closed
[v6.x backport] doc: standardize function param/object prop style#16560matejkrajcovic wants to merge 3 commits into
matejkrajcovic wants to merge 3 commits into
Conversation
PR-URL: nodejs#13769 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: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
3 tasks
gibfahn
reviewed
Oct 27, 2017
Member
gibfahn
left a comment
gibfahn
left a comment
There was a problem hiding this comment.
There are a couple of bits that should probably be wrapped at 80 columns, but otherwise LGTM.
Thank you so much for doing this!
| * `encoding` {string} **Default:** `'utf8'` | ||
| * `timeout` {number} **Default:** `0` | ||
| * [`maxBuffer`][] {number} Largest amount of data (in bytes) allowed on | ||
| stdout or stderr - if exceeded child process is killed. **Default:*: `200*1024` |
Member
There was a problem hiding this comment.
Missing the second * after Default here.
Contributor
Author
|
@gibfahn Both issues are fixed. |
Contributor
Author
|
@gibfahn Please look at this again. Is there anything I should change? |
Contributor
|
landed in 0f3901a |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Backport of #13769.
Checklist
Affected core subsystem(s)
doc