Repository navigation
docs: use explicit metavar to improve help formatting - #42
Merged
Merged
Conversation
roedoejet
requested changes
Nov 2, 2026
roedoejet
left a comment
roedoejet
left a comment
Member
There was a problem hiding this comment.
I really like the motivation behind this, I think we can tweak the changes a bit.
| "--output-type", | ||
| help="Output format(s) to produce.", | ||
| metavar="<format>", | ||
| help="Output format(s) to produce. One of: wav", |
Member
There was a problem hiding this comment.
This is obviously going to be changed to more than just wav but it's a little confusing to say "One of: wav"
For all of these situations where we've changed to a metavar, I think we should make it a bit clearer what the possible options are, maybe bolded at the top, with something like:
"Which format(s) to synthesize to: wav. Repeat --output-type to provide several output formats."
Member
Author
There was a problem hiding this comment.
This one I'll change to For now, only '**wav**' is supported until we implement more.
roedoejet
approved these changes
Nov 3, 2026
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
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.
EveryVoiceTTS/EveryVoice#901