Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion clap_builder/src/output/help_template.rs
Original file line number Diff line number Diff line change
Expand Up @@ -657,12 +657,15 @@ impl HelpTemplate<'_, '_> {
help.indent("", &trailing_indent);
self.writer.push_styled(&help);

let mut has_possible_values = false;
if let Some(arg) = arg {
if !arg.is_hide_possible_values_set() && self.use_long_pv(arg) {
const DASH_SPACE: usize = "- ".len();
let possible_vals = arg.get_possible_values();
if !possible_vals.is_empty() {
debug!("HelpTemplate::help: Found possible vals...{possible_vals:?}");
has_possible_values = true;

let longest = possible_vals
.iter()
.filter(|f| !f.is_hide_set())
Expand Down Expand Up @@ -709,7 +712,7 @@ impl HelpTemplate<'_, '_> {

if !spec_vals.is_empty() && next_line_specs {
let mut help = StyledStr::new();
if !help_is_empty {
if !help_is_empty || has_possible_values {
let sep = "\n\n";
help.push_str(sep);
}
Expand Down
35 changes: 35 additions & 0 deletions tests/builder/help.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3107,6 +3107,41 @@ fn too_many_value_names_panics() {
.debug_assert();
}

#[test]
fn help_enum_arg_with_no_description() {
let cmd = Command::new("test").arg(
Arg::new("config")
.action(ArgAction::Set)
// .help("No help description for this argument")
.short('c')
.long("config")
.value_name("MODE")
.value_parser([
PossibleValue::new("fast"),
PossibleValue::new("slow").help("slower than fast"),
PossibleValue::new("secret speed").hide(true),
])
.default_value("fast"),
);

let expected = str![[r#"
Usage: test [OPTIONS]

Options:
-c, --config <MODE>
Possible values:
- fast
- slow: slower than fast

[default: fast]

-h, --help
Print help (see a summary with '-h')

"#]];
utils::assert_output(cmd, "test --help", expected, false);
}

#[test]
fn disabled_help_flag() {
let res = Command::new("foo")
Expand Down