doc: child_process.kill() on windows needs clarification

[s4m0r4m4]

📗 API Reference Docs Problem

• Version: v14 and previous ones as well, like v12 LTS

• Platform: Windows

• Subsystem: child_process signals

Location

Section of the site where the content exists

Affected URL(s):

• https://nodejs.org/api/child_process.html

Description

Concise explanation of the problem

The NodeJS signals documentation (https://nodejs.org/api/process.html#process_signal_events) is pretty clear that on windows child_process.kill() does NOT actually send the signal, but rather just kills the child process abruptly.

However, the child_process.kill() documentation does not make this clarification, and it's opening sentence ("The subprocess.kill() method sends a signal to the child process. ") leads one to believe that the signal will in fact be sent to the child process on any platform, windows included.

I'd love to just see a quick blurb/sentence that clarifies the behavior on windows vs other platforms (or perhaps just a link pointing to the signals documentation - https://nodejs.org/api/process.html#process_signal_events).

---

• I would like to work on this issue and
  submit a pull request.

[joaolucasl]

I can work on this if you're not willing to submit the PR yourself @s4m0r4m4, would that be okay?

[s4m0r4m4]

Totally! I'm haven't contributed to the NodeJS docs before so I'm fine with you doing it!

[juanarbol]

Thank you @s4m0r4m4 for your report, amazing, and thank you @joaolucasl for offering to help. Leave a comment if you need help.

[joaolucasl]

@juanarbol @s4m0r4m4

Just opened a PR with an initial paragraph to make this clearer. Let me know with a comment there if you have suggestions :)