Skip to content
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

Jump to bottom

Fix:(issue 1689) Match markdown output with help output #1723

Merged
merged 4 commits into from Apr 30, 2023
Merged

Fix:(issue 1689) Match markdown output with help output #1723

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57cbb2d
Fix:(issue_1689) Let markdown output behave similar to cli help output
dearchap Apr 17, 2023
a78aa8c
Update tests
dearchap Apr 17, 2023
d31582c
Update fish_test.go
dearchap Apr 26, 2023
5b9c03e
Change from code review
dearchap Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs.go
View file
Open in desktop
Expand Up @@ -153,9 +153,14 @@ func prepareFlags(
// flagDetails returns a string containing the flags metadata
func flagDetails(flag DocGenerationFlag) string {
description := flag.GetUsage()
value := flag.GetValue()
if value != "" {
description += " (default: " + value + ")"
if flag.TakesValue() {
defaultText := flag.GetDefaultText()
if defaultText == "" {
defaultText = flag.GetValue()
}
if defaultText != "" {
description += " (default: " + defaultText + ")"
}
}
return ": " + description
}
Expand Down
11 changes: 6 additions & 5 deletions fish_test.go
View file
Open in desktop
Expand Up @@ -27,11 +27,12 @@ func testApp() *App {
app.Name = "greet"
app.Flags = []Flag{
&StringFlag{
Name: "socket",
Aliases: []string{"s"},
Usage: "some 'usage' text",
Value: "value",
TakesFile: true,
Name: "socket",
Aliases: []string{"s"},
Usage: "some 'usage' text",
Value: "value",
DefaultText: "svalue",
dearchap marked this conversation as resolved.
Show resolved Hide resolved
TakesFile: true,
},
&StringFlag{Name: "flag", Aliases: []string{"fl", "f"}},
&BoolFlag{
Expand Down
2 changes: 1 addition & 1 deletion testdata/expected-doc-full.man
View file
Open in desktop
Expand Up @@ -47,7 +47,7 @@ app [first_arg] [second_arg]
\fB--flag, --fl, -f\fP="":

.PP
\fB--socket, -s\fP="": some 'usage' text (default: value)
\fB--socket, -s\fP="": some 'usage' text (default: svalue)


.SH COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion testdata/expected-doc-full.md
View file
Open in desktop
Expand Up @@ -28,7 +28,7 @@ app [first_arg] [second_arg]

**--flag, --fl, -f**="":

**--socket, -s**="": some 'usage' text (default: value)
**--socket, -s**="": some 'usage' text (default: svalue)


# COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion testdata/expected-doc-no-authors.md
View file
Open in desktop
Expand Up @@ -28,7 +28,7 @@ app [first_arg] [second_arg]

**--flag, --fl, -f**="":

**--socket, -s**="": some 'usage' text (default: value)
**--socket, -s**="": some 'usage' text (default: svalue)


# COMMANDS
Expand Down
2 changes: 1 addition & 1 deletion testdata/expected-doc-no-commands.md
View file
Open in desktop
Expand Up @@ -28,5 +28,5 @@ app [first_arg] [second_arg]

**--flag, --fl, -f**="":

**--socket, -s**="": some 'usage' text (default: value)
**--socket, -s**="": some 'usage' text (default: svalue)

2 changes: 1 addition & 1 deletion testdata/expected-doc-no-usagetext.md
View file
Open in desktop
Expand Up @@ -28,7 +28,7 @@ greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

**--flag, --fl, -f**="":

**--socket, -s**="": some 'usage' text (default: value)
**--socket, -s**="": some 'usage' text (default: svalue)


# COMMANDS
Expand Down