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.

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

docs: improve process event headers #20312

Closed
wants to merge 1 commit into from

Conversation

BridgeAR
Copy link
Member

The headers should be handled as all others as well and just indicate
all arguments.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

The headers should be handled as all others as well and just indicate
all arguments.
@BridgeAR BridgeAR requested a review from vsemozhetbyt April 26, 2018 00:20
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 26, 2018
@BridgeAR
Copy link
Member Author

@vsemozhetbyt vsemozhetbyt added the process Issues and PRs related to the process subsystem. label Apr 26, 2018
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt left a comment

Choose a reason for hiding this comment

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

With a nit concern)

@@ -82,16 +84,15 @@ process.on('exit', (code) => {
added: v0.5.10
-->

* `message` {Object} a parsed JSON object or primitive value.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure if we should explicitly enumerate "primitive values" here. What types can they be?
{Object | boolean | number | string | null }?
It seems any does not suffice as there hardly can be undefined or symbol.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hm, I have no strong opinion. @Trott maybe?

Copy link
Member Author

Choose a reason for hiding this comment

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

Since I did not change the current state, I guess this can be addressed at a different point of time as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

@BridgeAR
Copy link
Member Author

@nodejs/documentation PTAL

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 27, 2018
BridgeAR added a commit to BridgeAR/node that referenced this pull request Apr 29, 2018
The headers should be handled as all others as well and just indicate
all arguments.

PR-URL: nodejs#20312
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@BridgeAR
Copy link
Member Author

Landed in b92c656

@BridgeAR BridgeAR closed this Apr 29, 2018
MylesBorins pushed a commit that referenced this pull request May 4, 2018
The headers should be handled as all others as well and just indicate
all arguments.

PR-URL: #20312
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@MylesBorins MylesBorins mentioned this pull request May 8, 2018
@BridgeAR BridgeAR deleted the improve-process-docs branch January 20, 2020 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants