FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: optimize child process doc by theanarkh · Pull Request #52154 · nodejs/node · GitHub

/ node Public

doc: optimize child process doc - #52154

Merged
aduh95 merged 1 commit into
nodejs:mainfrom
theanarkh:optimize_child_process_doc
Mar 26, 2024
ConversationCommits (1)ChecksFiles changed
Merged

doc: optimize child process doc#52154
aduh95 merged 1 commit into
nodejs:mainfrom
theanarkh:optimize_child_process_doc

Conversation

theanarkh commented Mar 19, 2024

Copy link
Copy Markdown
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 added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Mar 19, 2024
aduh95 reviewed Mar 20, 2024
View reviewed changes

aduh95 left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread doc/api/child_process.md Outdated
Comment thread doc/api/child_process.md Outdated

theanarkh commented Mar 20, 2024

Copy link
Copy Markdown
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 😄.

theanarkh force-pushed the optimize_child_process_doc branch from 5c40dd6 to 8f3b8a4 Compare March 20, 2024 14:15

aduh95 commented Mar 20, 2024

Copy link
Copy Markdown
Contributor

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?

theanarkh force-pushed the optimize_child_process_doc branch from 8f3b8a4 to 3f9b2e5 Compare March 20, 2024 14:43
lpinca approved these changes Mar 23, 2024
View reviewed changes
Comment thread doc/api/child_process.md Outdated
doc: improve child_process doc
0bb700e 
1. Clarify that which types of objects can be sent through process.send
2. Clarify that IPC handle are not supported on win32 platform
theanarkh force-pushed the optimize_child_process_doc branch from 3f9b2e5 to 0bb700e Compare March 24, 2024 06:44
aduh95 merged commit 312ebd9 into nodejs:main Mar 26, 2024

aduh95 commented Mar 26, 2024

Copy link
Copy Markdown
Contributor

Landed in 312ebd9

RafaelGSS mentioned this pull request Apr 15, 2024
Merged
marco-ippolito pushed a commit that referenced this pull request May 2, 2024
doc: edit ChildProcess 'message' event docs
743ed30 
- 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 mentioned this pull request May 2, 2024
Merged
marco-ippolito pushed a commit that referenced this pull request May 3, 2024
doc: edit ChildProcess 'message' event docs
bf0ed95 
- 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>
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes
aduh95 aduh95 approved these changes

Assignees

No one assigned

Labels

child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL