Skip to content

doc: add process api data types to documentation - #9505

Closed
imatveev wants to merge 4 commits into
nodejs:masterfrom
imatveev:docs-process-props-data-type
Closed

doc: add process api data types to documentation#9505
imatveev wants to merge 4 commits into
nodejs:masterfrom
imatveev:docs-process-props-data-type

Conversation

@imatveev

@imatveevimatveev commented Nov 7, 2016

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Clarified part of data types of properties and return values of process module in docs due to item

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. labels Nov 7, 2016
Comment threaddoc/api/process.md Outdated

For example:

```sh

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This shouldn't be sh if we're converting it to a JavaScript string value, it should be js.

Comment threaddoc/api/process.md Outdated

* `previousValue` {Object} A previous return value from calling
`process.cpuUsage()`
* return: {Object}

@mscdexmscdexNov 8, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you capitalize every instance of 'return' to look like 'Return'?

Comment threaddoc/api/process.md Outdated
added: v0.11.8
-->

* {Number}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You might be more specific here and use {Integer} instead.

Comment threaddoc/api/process.md Outdated
added: v0.1.28
-->

* return: {Number}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ditto about using {Integer}.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same goes for any other non-floating point number values.

@imatveev

Copy link
Copy Markdown
ContributorAuthor

Added changes according to @mscdex review.

Comment threaddoc/api/process.md Outdated
added: v0.2.0
-->

* Return: {Object}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think "Return:" should be removed here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Agreed.

@mscdex

Copy link
Copy Markdown
Contributor

LGTM

Comment threaddoc/api/process.md
added: v0.1.104
-->

* {String}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For consistency with the other changes, maybe add a blank line after this line.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

@mhdawsonmhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@silverwind

Copy link
Copy Markdown
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>
@MylesBorins

Copy link
Copy Markdown
Contributor

is this accurate for v4 or v6?

@imatveev

Copy link
Copy Markdown
ContributorAuthor

Checked on V6, can check on V4 if it needs to be done.

@imatveev
imatveev deleted the docs-process-props-data-type branch December 15, 2016 22:26
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>
@MylesBorinsMylesBorins mentioned this pull request Dec 21, 2016
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.processIssues and PRs related to the process subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@imatveev@mscdex@silverwind@MylesBorins@lpinca@cjihrig@mhdawson@nodejs-github-bot