Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[v6.x backport] doc: standardize function param/object prop style #16560

Closed
wants to merge 3 commits into from
Closed

[v6.x backport] doc: standardize function param/object prop style #16560

wants to merge 3 commits into from

Conversation

matejkrajcovic
Copy link
Contributor

Backport of #13769.

Checklist
Affected core subsystem(s)

doc

@gibfahn @matejkrajcovic
doc: standardize function param/object prop style
e103e03 
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>
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. v6.x labels Oct 27, 2017
@matejkrajcovic matejkrajcovic mentioned this pull request Oct 27, 2017
Closed
3 tasks
gibfahn
gibfahn reviewed Oct 27, 2017
View reviewed changes
Copy link
Member

@gibfahn gibfahn left a comment

Choose a reason for hiding this comment

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

There are a couple of bits that should probably be wrapped at 80 columns, but otherwise LGTM.

Thank you so much for doing this!

doc/api/child_process.md Outdated
* `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`
Copy link
Member

Choose a reason for hiding this comment

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

Missing the second * after Default here.

@matejkrajcovic
Copy link
Contributor Author

@gibfahn Both issues are fixed.

@matejkrajcovic
Copy link
Contributor Author

@gibfahn Please look at this again. Is there anything I should change?

MylesBorins pushed a commit that referenced this pull request Nov 3, 2017
@gibfahn @MylesBorins
doc: standardize function param/object prop style
0f3901a 
Backport-PR-URL: #16560
PR-URL: #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>
@MylesBorins
Copy link
Contributor

landed in 0f3901a

@MylesBorins MylesBorins closed this Nov 3, 2017
@matejkrajcovic matejkrajcovic deleted the backport-13769-to-v6.x branch November 3, 2017 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gibfahn gibfahn gibfahn left review comments

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@matejkrajcovic @MylesBorins @gibfahn @nodejs-github-bot