Skip to content

Use default: in arg descriptions too, standardising the format #208

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
FollowTheProcess merged 1 commit into from
Apr 22, 2026
Merged

Use default: in arg descriptions too, standardising the format #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ func writeArgumentsSection(cmd *Command, s *strings.Builder) error {
for _, arg := range cmd.args {
line := fmt.Sprintf(" %s\t%s\t%s\t[required]", style.Bold.Text(arg.Name()), arg.Type(), arg.Usage())
if arg.Default() != "" {
line = fmt.Sprintf(" %s\t%s\t%s\t[default %s]", style.Bold.Text(arg.Name()), arg.Type(), arg.Usage(), arg.Default())
line = fmt.Sprintf(" %s\t%s\t%s\t[default: %s]", style.Bold.Text(arg.Name()), arg.Type(), arg.Usage(), arg.Default())
}

fmt.Fprintln(tw, line)
Expand Down
4 changes: 2 additions & 2 deletions testdata/snapshots/TestHelp/with_named_arguments.snap.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Usage: test [OPTIONS] SRC [DEST] [OTHER]
Arguments:

src string The file to copy [required]
dest string Destination to copy to [default default.txt]
other int Something else [default 0]
dest string Destination to copy to [default: default.txt]
other int Something else [default: 0]

Options:

Expand Down
2 changes: 1 addition & 1 deletion testdata/snapshots/TestHelp/with_verbosity_count.snap.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Usage: test [OPTIONS] SRC [DEST]
Arguments:

src string The file to copy [required]
dest string Destination to copy to [default destination.txt]
dest string Destination to copy to [default: destination.txt]

Options:

Expand Down
Loading