docs: update external command documentation #10333
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
|
Review period will end on 2021-01-18 at 02:52:18 UTC. |
BrewTestBot
added
the
waiting for feedback
8 tasks
Co-authored-by: Eric Knibbe <enk3@outlook.com>
|
Good suggestions, thanks, @EricFromCanada! |
|
Review period ended. |
BrewTestBot
removed
the
waiting for feedback
BrewTestBot
approved these changes
Jan 18, 2021
|
Putting this on hold for now until #10342 is merged so that those changes can be reflected here. |
|
Okay, now that #10342 has been merged, I've updated this PR to include information about auto-generated usage strings. I'll leave this open for now for any last feedback and I'll plan on merging sometime tomorrow. |
|
LGTM 👍🏻 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
brew stylewith your changes locally?brew typecheckwith your changes locally?brew testswith your changes locally?brew manlocally and committed any changes?Follow up to #10288
This PR updates the documentation around external commands and how to use the new
named_argsmethod.My ultimate goal is to have completions be automatically generated based on
named_argsand to have an e.g.brew generate-completionscommand that will generate completions automatically for a tap. Given this, let me know if it's better for this PR to wait until that's ready (in order to document both at the same time).