Skip to content

make_docs.nu: fix flags code to only add short_flag when needed #1658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 6, 2024
Merged

make_docs.nu: fix flags code to only add short_flag when needed #1658

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8ef22c
`make_docs.nu`: fix flags code to only add `short_flag` when needed
paulie4 Dec 3, 2024
ffbe438
run `make_docs.nu`
paulie4 Dec 3, 2024
5532f99
Revert "run `make_docs.nu`"
paulie4 Dec 5, 2024
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
13 changes: 8 additions & 5 deletions make_docs.nu
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,14 @@ def command-doc [command] {

let flags = if $no_flags { '' } else {
($command.signatures | get $columns.0 | each { |param|
if $param.parameter_type == "switch" {
$" - `--($param.parameter_name), -($param.short_flag)`: ($param.description)"
} else if $param.parameter_type == "named" {
$" - `--($param.parameter_name), -($param.short_flag) {($param.syntax_shape)}`: ($param.description)"
}
let start = $' - `--($param.parameter_name)'
let end = $'`: ($param.description)'
let short_flag = (if ($param.short_flag | is-empty) {''} else {$', -($param.short_flag)'})
if $param.parameter_type == 'switch' {
$'($start)($short_flag)($end)'
} else if $param.parameter_type == 'named' {
$'($start)($short_flag) {($param.syntax_shape)}($end)'
}
} | str join (char newline))
}

Expand Down
Loading