Improve documentation of sync methods #540
Merged
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
index.d.ts
Outdated
|
|
||
| @param file - The program/script to execute. | ||
| @param arguments - Arguments to pass to `file` on execution. | ||
| @returns A result `Object` with `stdout` and `stderr` properties. | ||
| @returns A `childProcessResult` object. This is also thrown on error. |
There was a problem hiding this comment.
Wonder if the @throws tag is appropriate here.
There was a problem hiding this comment.
Good point! Fixed. 👍
I also added @throws to all the main methods, and made their @returns be consistent with each other.
aaronccasanova
approved these changes
Mar 9, 2023
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.
Just like in core Node.js modules, synchronous methods should mostly be avoided, except in specific situations where they are necessary. This PR improves their documentation based on this.
First, it moves them down in the readme and group them together. This reduces the amount of things to learn for users: they can just focus on the differences on the 4 main invocation methods, and then, as a follow-up, learn that synchronous methods for them exist as well.
Second, their description in both the readme and the type tests were a little out-of-sync. This updates them.