doc: add process api data types to documentation#9505
Closed
imatveev wants to merge 4 commits intonodejs:masterfrom
Closed
doc: add process api data types to documentation#9505imatveev wants to merge 4 commits intonodejs:masterfrom
imatveev wants to merge 4 commits intonodejs:masterfrom
Conversation
nodejs-github-bot
added
doc
mscdex
reviewed
Nov 8, 2016
doc/api/process.md
Outdated
|
|
||
| For example: | ||
|
|
||
| ```sh |
Contributor
There was a problem hiding this comment.
This shouldn't be sh if we're converting it to a JavaScript string value, it should be js.
mscdex
reviewed
Nov 8, 2016
doc/api/process.md
Outdated
|
|
||
| * `previousValue` {Object} A previous return value from calling | ||
| `process.cpuUsage()` | ||
| * return: {Object} |
Contributor
There was a problem hiding this comment.
Can you capitalize every instance of 'return' to look like 'Return'?
mscdex
reviewed
Nov 8, 2016
doc/api/process.md
Outdated
| added: v0.11.8 | ||
| --> | ||
|
|
||
| * {Number} |
Contributor
There was a problem hiding this comment.
You might be more specific here and use {Integer} instead.
mscdex
reviewed
Nov 8, 2016
doc/api/process.md
Outdated
| added: v0.1.28 | ||
| --> | ||
|
|
||
| * return: {Number} |
Contributor
There was a problem hiding this comment.
Ditto about using {Integer}.
Contributor
There was a problem hiding this comment.
Same goes for any other non-floating point number values.
Contributor
Author
|
Added changes according to @mscdex review. |
lpinca
reviewed
Nov 8, 2016
doc/api/process.md
Outdated
| added: v0.2.0 | ||
| --> | ||
|
|
||
| * Return: {Object} |
Member
There was a problem hiding this comment.
I think "Return:" should be removed here.
lpinca
approved these changes
Nov 8, 2016
Contributor
|
LGTM |
cjihrig
reviewed
Nov 8, 2016
| added: v0.1.104 | ||
| --> | ||
|
|
||
| * {String} |
Contributor
There was a problem hiding this comment.
For consistency with the other changes, maybe add a blank line after this line.
cjihrig
approved these changes
Nov 8, 2016
2 tasks
silverwind
approved these changes
Nov 11, 2016
Contributor
|
Thanks! Landed in c184f22. |
silverwind
pushed a commit
that referenced
this pull request
Nov 11, 2016
PR-URL: #9505 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Roman Reiss <me@silverwind.io>
addaleax
pushed a commit
that referenced
this pull request
Nov 22, 2016
PR-URL: #9505 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Contributor
|
is this accurate for v4 or v6? |
Contributor
Author
|
Checked on V6, can check on V4 if it needs to be done. |
MylesBorins
pushed a commit
that referenced
this pull request
Dec 21, 2016
PR-URL: #9505 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 21, 2016
PR-URL: #9505 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Merged
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
8 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.
Checklist
Affected core subsystem(s)
doc
Description of change
Clarified part of data types of properties and return values of
processmodule in docs due to item