doc: refactor signal info in child_process.md #37528
Closed
Conversation
This file contains 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
nodejs-github-bot
added
child_process
|
Maybe we should add the info in the YAML list as well: - version: v15.4.0
pr-url: https://github.com/nodejs/node/pull/36308
description: AbortSignal support was added. |
benjamingr
reviewed
Feb 27, 2021
doc/api/child_process.md
Outdated
| @@ -246,6 +248,9 @@ async function lsExample() { | |||
| lsExample(); | |||
| ``` | |||
|
|
|||
| The `signal` option works exactly the same way it does in | |||
There was a problem hiding this comment.
An example would be nice here :]
benjamingr
reviewed
Feb 27, 2021
doc/api/child_process.md
Outdated
| }); | ||
| controller.abort(); | ||
| ``` | ||
| The `signal` option works exactly the same way it does in |
There was a problem hiding this comment.
I actually think examples in APIs are better than not - since users often don't know all the APIs they're working with - sending them to another API (spawn) when they're trying to use execFile isn't better than an example using execFile IMO.
The fact internally execFile delegates to spawn to save code internally is an implementation detail
|
I like adding it to missing APIs but I strongly prefer having examples in APIs to illustrate to users how to use them. (And half the days I don't remember the difference between exec/execFile/fork/spawn myself, and I've been a collaborator for 5 years and a user for ±10 and I implemented the signal support for child_process :D) |
RaisinTen
force-pushed
the
doc/add-signal-to-exec-options-in-child_process.md
branch
from
8a9f442
to
48ea299
Compare
@aduh95 thanks! I added it. |
RaisinTen
force-pushed
the
doc/add-signal-to-exec-options-in-child_process.md
branch
from
48ea299
to
8b5765a
Compare
* Since exec calls execFile and execFile internally calls spawn with options.signal, the signal parameter has been documented under exec as well. * Refactor the description of signal under all the functions. * Add examples of usage of signal under all the functions and add missing requires in the other examples.
RaisinTen
force-pushed
the
doc/add-signal-to-exec-options-in-child_process.md
branch
from
8b5765a
to
940959e
Compare
benjamingr
approved these changes
Feb 27, 2021
The lint errors are fixed. Thanks for reviewing! :) |
RaisinTen
added
the
author ready
|
Can you add the YAML metadata for |
marsonya
approved these changes
Feb 27, 2021
aduh95
approved these changes
Feb 27, 2021
RaisinTen
added a commit
that referenced
this pull request
Mar 4, 2021
* Since exec calls execFile and execFile internally calls spawn with options.signal, the signal parameter has been documented under exec as well. * Refactor the description of signal under all the functions. * Add examples of usage of signal under all the functions and add missing requires in the other examples. PR-URL: #37528 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
|
Landed in 5248a17 |
danielleadams
pushed a commit
that referenced
this pull request
Mar 16, 2021
* Since exec calls execFile and execFile internally calls spawn with options.signal, the signal parameter has been documented under exec as well. * Refactor the description of signal under all the functions. * Add examples of usage of signal under all the functions and add missing requires in the other examples. PR-URL: #37528 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Merged
targos
pushed a commit
to targos/node
that referenced
this pull request
Aug 8, 2021
* Since exec calls execFile and execFile internally calls spawn with options.signal, the signal parameter has been documented under exec as well. * Refactor the description of signal under all the functions. * Add examples of usage of signal under all the functions and add missing requires in the other examples. PR-URL: nodejs#37528 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos
pushed a commit
that referenced
this pull request
Sep 1, 2021
* Since exec calls execFile and execFile internally calls spawn with options.signal, the signal parameter has been documented under exec as well. * Refactor the description of signal under all the functions. * Add examples of usage of signal under all the functions and add missing requires in the other examples. PR-URL: #37528 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
execcallsexecFileandexecFileinternally callsspawnwithoptions.signal, thesignalparameter has been documented underexecas well.
signalunder all the functions.signalunder all the functions and addmissing
requires in the other examples.