Include options for compatgen targets in Usage help #1581
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
Signed-off-by: Judith van Stegeren <judith@replicate.com>
jd7h
added
documentation
zeke
approved these changes
Mar 14, 2024
There was a problem hiding this comment.
I wasn't familiar with this {foo|bar|baz} syntax for describing allowable values in an argument, so I went on a ChatGPT odyssey to understand it.
Looks like this is legit! 👍🏼
Another approach would be to leave it as compatgen <target> and expound on the values and their meanings using some combination of Short, Long, and Example.
|
Yes, this is common syntax. You can see the same syntax in |
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.
Make the help message of compatgen clearer by explicitly stating the valid options for .