Uh oh!
There was an error while loading. Please reload this page.
doc: add process api data types to documentation - #9505
Conversation
| For example: | ||
| ```sh |
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.
| * `previousValue` {Object} A previous return value from calling | ||
| `process.cpuUsage()` | ||
| * return: {Object} |
There was a problem hiding this comment.
Can you capitalize every instance of 'return' to look like 'Return'?
| added: v0.11.8 | ||
| --> | ||
| * {Number} |
There was a problem hiding this comment.
You might be more specific here and use {Integer} instead.
| added: v0.1.28 | ||
| --> | ||
| * return: {Number} |
There was a problem hiding this comment.
Same goes for any other non-floating point number values.
imatveev
commented
Nov 8, 2016
Added changes according to @mscdex review. |
| added: v0.2.0 | ||
| --> | ||
| * Return: {Object} |
There was a problem hiding this comment.
I think "Return:" should be removed here.
mscdex
commented
Nov 8, 2016
LGTM |
| added: v0.1.104 | ||
| --> | ||
| * {String} |
There was a problem hiding this comment.
For consistency with the other changes, maybe add a blank line after this line.
silverwind
commented
Nov 11, 2016
Thanks! Landed in c184f22. |
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>
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
commented
Dec 13, 2016
is this accurate for v4 or v6? |
imatveev
commented
Dec 14, 2016
Checked on V6, can check on V4 if it needs to be done. |
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>
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>
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