docs: describe commandDir() parameters (#1540)#1613
Merged
bcoe merged 4 commits intoyargs:masterfrom Jun 2, 2020
Merged
Conversation
Member
|
@bennyn thanks for the contribution 👍 I'm excited to document this. One thing jumps out at me, the formatting is a bit off compared to how we've documented parameters elsewhere in the doc: https://github.com/yargs/yargs/blob/master/docs/api.md#commandmodule Where we've just used a paragraph per parameter, with the parameter starting in |
Contributor
Author
|
Hey @bcoe, I will update my PR matching your style guide! |
Contributor
Author
|
@bcoe Style updated! 👍 |
bcoe
approved these changes
Jun 2, 2020
Member
|
@bennyn thank you for the contribution \o/ |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The
commandDiroption is explained in Advanced Topics but missing from the API list.