extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-22 00:13:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove superfluous separator when there's no flag description/comment (#14007)

Browse Source 
# Description

Fixes a small side-issue in #10977 - If a command flag didn't have a
comment/description, it would still show an unnecessary separator at the
end of the line.

This fixes that, plus uses the `: ` (colon) to separate the flag from
the description. This aligns with the way that named parameters are
handled.

# User-Facing Changes

Help/doc only

# Tests + Formatting

- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`

# After Submitting

N/A
This commit is contained in:
Douglas 2024-10-05 09:19:26 -04:00 committed by GitHub
parent baadaee016
commit 68377c176d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/nu-engine/src/documentation.rs
View File

@ -572,7 +572,9 @@ where
document_shape(arg) document_shape(arg)
); );
} }
let _ = write!(long_desc, " - {}", flag.desc); if !flag.desc.is_empty() {
let _ = write!(long_desc, ": {}", flag.desc);
}
if let Some(value) = &flag.default_value { if let Some(value) = &flag.default_value {
let _ = write!(long_desc, " (default: {})", &value_formatter(value)); let _ = write!(long_desc, " (default: {})", &value_formatter(value));
} }

8
tests/repl/test_help.rs
View File

@ -6,11 +6,11 @@ use rstest::rstest;
#[case(": arga help")] #[case(": arga help")]
#[case("argb help")] #[case("argb help")]
#[case("optional, default: 20")] #[case("optional, default: 20")]
#[case("- f1 switch")] #[case(": f1 switch")]
#[case("- f2 named no default")] #[case(": f2 named no default")]
#[case("- f3 named default 3")] #[case(": f3 named default 3")]
#[case("default: 33")] #[case("default: 33")]
#[case("--help - Display the help message")] #[case("--help: Display the help message")]
fn can_get_help(#[case] exp_result: &str) -> TestResult { fn can_get_help(#[case] exp_result: &str) -> TestResult {
run_test( run_test(
&format!( &format!(