doc: clarify when child process 'spawn' event is *not* emitted

zenflow · targos · commit b31bb72c10a3 · 2021-05-01T12:25:27.000+02:00
Making this clarification in response to a comment on GitHub: #35288 (comment) PR-URL: #37833 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -1088,6 +1088,8 @@ added: REPLACEME
 -->
 
 The `'spawn'` event is emitted once the child process has spawned successfully.
+If the child process does not spawn successfully, the `'spawn'` event is not
+emitted and the `'error'` event is emitted instead.
 
 If emitted, the `'spawn'` event comes before all other events and before any
 data is received via `stdout` or `stderr`.
