Skip to content

doc: child_process.kill() on windows needs clarification #34858

Description

@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):

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions