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 missing option value names in manuals #473

Merged
merged 1 commit into from Aug 26, 2022
Merged

Fix missing option value names in manuals #473

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions Tests/ArgumentParserGenerateManualTests/CountLinesGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -27,9 +27,9 @@ final class CountLinesGenerateManualTests: XCTestCase {
.Sh SYNOPSIS
.Nm
.Ar input-file
.Op Fl -prefix
.Op Fl -verbose Ar verbose
.Fl -help Ar help
.Op Fl -prefix Ar prefix
.Op Fl -verbose
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Ar input-file
Expand Down Expand Up @@ -69,9 +69,9 @@ final class CountLinesGenerateManualTests: XCTestCase {
.Sh SYNOPSIS
.Nm
.Ar input-file
.Op Fl -prefix
.Op Fl -verbose Ar verbose
.Fl -help Ar help
.Op Fl -prefix Ar prefix
.Op Fl -verbose
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Ar input-file
Expand Down
54 changes: 27 additions & 27 deletions Tests/ArgumentParserGenerateManualTests/MathGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -26,8 +26,8 @@ final class MathGenerateManualTests: XCTestCase {
.Sh SYNOPSIS
.Nm
.Ar subcommand
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -version
Expand Down Expand Up @@ -131,8 +131,8 @@ final class MathGenerateManualTests: XCTestCase {
.Sh SYNOPSIS
.Nm
.Ar subcommand
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -version
Expand Down Expand Up @@ -166,10 +166,10 @@ final class MathGenerateManualTests: XCTestCase {
.Nd "Print the sum of the values."
.Sh SYNOPSIS
.Nm
.Op Fl -hex-output Ar hex-output
.Op Fl -hex-output
.Op Ar values...
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl x , -hex-output
Expand Down Expand Up @@ -203,10 +203,10 @@ final class MathGenerateManualTests: XCTestCase {
.Nd "Print the product of the values."
.Sh SYNOPSIS
.Nm
.Op Fl -hex-output Ar hex-output
.Op Fl -hex-output
.Op Ar values...
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl x , -hex-output
Expand Down Expand Up @@ -241,8 +241,8 @@ final class MathGenerateManualTests: XCTestCase {
.Sh SYNOPSIS
.Nm
.Ar subcommand
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -version
Expand Down Expand Up @@ -276,10 +276,10 @@ final class MathGenerateManualTests: XCTestCase {
.Nd "Print the average of the values."
.Sh SYNOPSIS
.Nm
.Op Fl -kind
.Op Fl -kind Ar kind
.Op Ar values...
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -kind Ar kind
Expand Down Expand Up @@ -314,8 +314,8 @@ final class MathGenerateManualTests: XCTestCase {
.Sh SYNOPSIS
.Nm
.Op Ar values...
.Fl -version Ar version
.Fl -help Ar help
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Ar values...
Expand Down Expand Up @@ -350,16 +350,16 @@ final class MathGenerateManualTests: XCTestCase {
.Op Ar one-of-four
.Op Ar custom-arg
.Op Ar values...
.Op Fl -test-success-exit-code Ar test-success-exit-code
.Op Fl -test-failure-exit-code Ar test-failure-exit-code
.Op Fl -test-validation-exit-code Ar test-validation-exit-code
.Op Fl -test-custom-exit-code
.Op Fl -file
.Op Fl -directory
.Op Fl -shell
.Op Fl -custom
.Fl -version Ar version
.Fl -help Ar help
.Op Fl -test-success-exit-code
.Op Fl -test-failure-exit-code
.Op Fl -test-validation-exit-code
.Op Fl -test-custom-exit-code Ar test-custom-exit-code
.Op Fl -file Ar file
.Op Fl -directory Ar directory
.Op Fl -shell Ar shell
.Op Fl -custom Ar custom
.Fl -version
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Ar one-of-four
Expand Down
12 changes: 6 additions & 6 deletions Tests/ArgumentParserGenerateManualTests/RepeatGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -23,10 +23,10 @@ final class RepeatGenerateManualTests: XCTestCase {
.Nm repeat
.Sh SYNOPSIS
.Nm
.Op Fl -count
.Op Fl -include-counter Ar include-counter
.Op Fl -count Ar count
.Op Fl -include-counter
.Ar phrase
.Fl -help Ar help
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -count Ar count
Expand Down Expand Up @@ -64,10 +64,10 @@ final class RepeatGenerateManualTests: XCTestCase {
.Nm repeat
.Sh SYNOPSIS
.Nm
.Op Fl -count
.Op Fl -include-counter Ar include-counter
.Op Fl -count Ar count
.Op Fl -include-counter
.Ar phrase
.Fl -help Ar help
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -count Ar count
Expand Down
20 changes: 10 additions & 10 deletions Tests/ArgumentParserGenerateManualTests/RollDiceGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -23,11 +23,11 @@ final class RollDiceGenerateManualTests: XCTestCase {
.Nm roll
.Sh SYNOPSIS
.Nm
.Op Fl -times
.Op Fl -sides
.Op Fl -seed
.Op Fl -verbose Ar verbose
.Fl -help Ar help
.Op Fl -times Ar n
.Op Fl -sides Ar m
.Op Fl -seed Ar seed
.Op Fl -verbose
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -times Ar n
Expand Down Expand Up @@ -69,11 +69,11 @@ final class RollDiceGenerateManualTests: XCTestCase {
.Nm roll
.Sh SYNOPSIS
.Nm
.Op Fl -times
.Op Fl -sides
.Op Fl -seed
.Op Fl -verbose Ar verbose
.Fl -help Ar help
.Op Fl -times Ar n
.Op Fl -sides Ar m
.Op Fl -seed Ar seed
.Op Fl -verbose
.Fl -help
.Sh DESCRIPTION
.Bl -tag -width 6n
.It Fl -times Ar n
Expand Down
2 changes: 1 addition & 1 deletion Tools/generate-manual/DSL/ArgumentSynopsis.swift
View file
Open in desktop
Expand Up @@ -32,11 +32,11 @@ struct ArgumentSynopsis: MDocComponent {
// preferredName cannot be nil
let name = argument.preferredName!
return MDocMacro.CommandOption(options: [name.manualPage])
.withUnsafeChildren(nodes: [argument.manualPageValueName])
case .flag:
// preferredName cannot be nil
let name = argument.preferredName!
return MDocMacro.CommandOption(options: [name.manualPage])
.withUnsafeChildren(nodes: [argument.manualPageValueName])
}
}
}