fix(help): quote empty string defaults in help output#6241
Open
njg7194 wants to merge 1 commit intoclap-rs:masterfrom
Open
fix(help): quote empty string defaults in help output#6241njg7194 wants to merge 1 commit intoclap-rs:masterfrom
njg7194 wants to merge 1 commit intoclap-rs:masterfrom
Conversation
Fixes clap-rs#4976 When a default value is an empty string, the help output now displays `[default: ""]` instead of `[default: ]`, making it clear that the default is an empty string rather than appearing to be missing. Changes: - help_template.rs: Added check for empty strings in default value display - possible_value.rs: Added check for empty strings in get_visible_quoted_name - format.rs: Added check for empty strings in Escape Display impl
Member
|
As noted in #4976 (comment) and https://github.com/clap-rs/clap/blob/master/CONTRIBUTING.md#preparing-the-pr, my expectations for this would be
|
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.
Fixes #4976
Summary
When a default value is an empty string, the help output now displays
[default: ""]instead of[default: ], making it clear that the default is an empty string rather than appearing to be missing.Changes
help_template.rs: Added check for empty strings in default value displaypossible_value.rs: Added check for empty strings inget_visible_quoted_nameformat.rs: Added check for empty strings inEscapeDisplay implBefore
After
This is a minimal change that follows the existing pattern of using Rust debug representation for values that need quoting.