feat: formalize existing callback argument to showHelp #1386
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
royra
changed the title
bcoe
reviewed
Jul 30, 2019
docs/api.md
Outdated
| .showHelp(printCallback) | ||
| --------------------------- | ||
|
|
||
| Print the usage data using the specified callback, which accepts a single argument - the string to print. |
There was a problem hiding this comment.
If I recall, can showHelp take no callback and it will result in help printing to stdout?
There was a problem hiding this comment.
@bcoe Right. Added doc section (and test) to explicitly describe that.
bcoe
reviewed
Jul 31, 2019
mleguen
requested changes
Aug 16, 2019
royra
force-pushed
the
fix_show_help_doc
branch
from
5a5ee7f
to
6850a1e
Compare
|
@royra your changes are in |
This was referenced Nov 25, 2021
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 PR adds doc and test for an existing feature: Supplying a print callback to
usage.showHelpinstead of aconsolefunction name.We use the callback in our code to explicitly specify the stdout/stderr stream dependencies of yargs - tests can use it instead of mocking the console.
Thanks for making this great library!