Improve examples in types documentation #546
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
ehmicky
commented
Mar 10, 2023
| The `shell` option must be used if the `command` uses shell-specific features (for example, `&&` or `||`), as opposed to being a simple `file` followed by its `arguments`. | ||
|
|
||
| As a convenience, the result from previous `` $`command` `` or `` $.sync`command` `` calls can be used as template expressions in subsequent commands and `$`/`$.sync` will use the `stdout` value. See the example below `` with results from `$` or `$.sync` `` for more details. | ||
| Binds options to the `$` API. For example, you can use `$(options)` to create a new `$` instance with specific default options, which are then bound to both the asynchronous `` $`command` `` and synchronous `` $.sync`command` `` APIs. |
There was a problem hiding this comment.
The previous code comments were incorrect, as this should document $(options), not $`command`. This fixes it.
ehmicky
commented
Mar 10, 2023
| */ | ||
| export const $: Execa$; | ||
|
|
||
| /** |
There was a problem hiding this comment.
Those lines are moved after execaCommand() instead.
ehmicky
commented
Mar 10, 2023
| @@ -179,7 +179,6 @@ try { | |||
| escapedCommand: 'unknown command', | |||
| stdout: '', | |||
| stderr: '', | |||
| all: '', | |||
There was a problem hiding this comment.
all is undefined there, not ''.
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.
Examples in the types documentation are currently out-of-sync with
readme.md. Also, some methods are missing them. This PR fixes this.