From 84a25eb7949a8ea887ddf8e23aa30f23a72fc5b1 Mon Sep 17 00:00:00 2001
From: cjihrig <cjihrig@gmail.com>
Date: Tue, 26 Nov 2019 13:37:31 -0500
Subject: [PATCH] child_process: document kill() return value

This commit documents the return value from subprocess.kill().

PR-URL: https://github.com/nodejs/node/pull/30669
Refs: https://github.com/nodejs/node/issues/30668
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
---
 doc/api/child_process.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index 7a025f94fade93..746de9bd2c8b7b 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -1061,10 +1061,12 @@ added: v0.1.90
 -->
 
 * `signal` {number|string}
+* Returns: {boolean}
 
 The `subprocess.kill()` method sends a signal to the child process. If no
 argument is given, the process will be sent the `'SIGTERM'` signal. See
-signal(7) for a list of available signals.
+signal(7) for a list of available signals. This function returns `true` if
+kill(2) succeeds, and `false` otherwise.
 
 ```js
 const { spawn } = require('child_process');