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

doc: optimize child process doc #52154

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

theanarkh
Copy link
Contributor

cc @bnoordhuis

  • 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

@nodejs-github-bot nodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Mar 19, 2024
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

I don't really understand the "optimize" part of the commit message. In what sense does this change optimize the docs?

doc/api/child_process.md Outdated Show resolved Hide resolved
doc/api/child_process.md Outdated Show resolved Hide resolved
@theanarkh
Copy link
Contributor Author

I don't really understand the "optimize" part of the commit message. In what sense does this change optimize the docs?

I'm trying to improve the documentation and point out that we can't send IPC handles on win32 platform 😄.

@aduh95
Copy link
Contributor

aduh95 commented Mar 20, 2024

I don't really understand the "optimize" part of the commit message. In what sense does this change optimize the docs?

I'm trying to improve the documentation and point out that we can't send IPC handles on win32 platform 😄.

Then maybe doc: clarify that IPC handles are not supported on win32 platform would be a better commit message?

doc/api/child_process.md Outdated Show resolved Hide resolved
1. Clarify that which types of objects can be sent through process.send
2. Clarify that IPC handle are not supported on win32 platform
@aduh95 aduh95 merged commit 312ebd9 into nodejs:main Mar 26, 2024
12 checks passed
@aduh95
Copy link
Contributor

aduh95 commented Mar 26, 2024

Landed in 312ebd9

rdw-msft pushed a commit to rdw-msft/node that referenced this pull request Mar 26, 2024
- Clarify which types of objects can be sent through `process.send`.
- Clarify that IPC handles are not supported on win32 platform.

PR-URL: nodejs#52154
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
marco-ippolito pushed a commit that referenced this pull request May 2, 2024
- Clarify which types of objects can be sent through `process.send`.
- Clarify that IPC handles are not supported on win32 platform.

PR-URL: #52154
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
marco-ippolito pushed a commit that referenced this pull request May 3, 2024
- Clarify which types of objects can be sent through `process.send`.
- Clarify that IPC handles are not supported on win32 platform.

PR-URL: #52154
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants