Improve documentation of the usage section #541
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
readme.md
Outdated
Comment on lines
56
to
63
| const unicorns = await $`echo unicorns`; | ||
| const {stdout} = await $`echo ${unicorns}${'!'}}`; | ||
| console.log(stdout); | ||
| //=> 'unicorns!' | ||
|
|
||
| const {stdout} = await $`echo ${['unicorns', 'rainbows']}`; | ||
| console.log(stdout); | ||
| //=> 'unicorns' | ||
| //=> 'unicorns rainbows' |
There was a problem hiding this comment.
This example errors on reassignment of the block-scoped var stdout
readme.md
Outdated
|
|
||
| const {stdout} = $.sync`echo unicorns`; | ||
| console.log(stdout); | ||
| await $$({shell: true})`echo unicorns && echo rainbows`; |
There was a problem hiding this comment.
This consolidation is nice, but removes the basic example of using the imported $ directly with options e.g. await $(options)`command`. I'm not sure if this will lead to confusion, but user might think they have to use the $$ = $(options) binding mechanism first.
There was a problem hiding this comment.
That's a good point, let's keep them split. Done 👍
sindresorhus
approved these changes
Mar 9, 2023
sindresorhus
changed the title
|
Fixed @aaronccasanova, ready for another code review 👍 |
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.
This improves the Usage section of the documentation. That section has been augmented ad-hoc incrementally over time and could use some small improvement. It also removes some information that is not strictly worth documenting, as it helps highlighting the features that are more interesting.
signaloption's example to the Tips sections, since it is not really a feature anymore now that the option is supported by thechild_processcore module.I am hoping those changes help the Usage section to better focus and highlight the major features that Execa does bring.