Skip to content

Commit 58fc542

Browse files
heckjheckj
committed
work in progress - help to full sentences.
1 parent 2d48848 commit 58fc542

12 files changed

+51
-51
lines changed

‎Sources/Commands/PackageCommands/APIDiff.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ struct APIDiff: AsyncSwiftCommand {
5959
""")
6060
var breakageAllowlistPath: AbsolutePath?
6161

62-
@Argument(help: "The baseline treeish to compare to (e.g. a commit hash, branch name, tag, etc.)")
62+
@Argument(help: "The baseline treeish to compare to (for example, a commit hash, branch name, tag, and so on).")
6363
var treeish: String
6464

6565
@Option(parsing: .upToNextOption,

‎Sources/Commands/PackageCommands/AddDependency.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@ extension SwiftPackageCommand {
2929
abstract: "Add a package dependency to the manifest"
3030
)
3131

32-
@Argument(help: "The URL or directory of the package to add")
32+
@Argument(help: "The URL or directory of the package to add.")
3333
var dependency: String
3434

3535
@OptionGroup(visibility: .hidden)
3636
var globalOptions: GlobalOptions
3737

38-
@Option(help: "The exact package version to depend on")
38+
@Option(help: "The exact package version to depend on.")
3939
var exact: Version?
4040

41-
@Option(help: "The specific package revision to depend on")
41+
@Option(help: "The specific package revision to depend on.")
4242
var revision: String?
4343

44-
@Option(help: "The branch of the package to depend on")
44+
@Option(help: "The branch of the package to depend on.")
4545
var branch: String?
4646

47-
@Option(help: "The package version to depend on (up to the next major version)")
47+
@Option(help: "The package version to depend on (up to the next major version).")
4848
var from: Version?
4949

50-
@Option(help: "The package version to depend on (up to the next minor version)")
50+
@Option(help: "The package version to depend on (up to the next minor version).")
5151
var upToNextMinorFrom: Version?
5252

53-
@Option(help: "Specify upper bound on the package version range (exclusive)")
53+
@Option(help: "Specify upper bound on the package version range (exclusive).")
5454
var to: Version?
5555

56-
@Option(help: "Specify dependency type")
56+
@Option(help: "Specify dependency type.")
5757
var type: DependencyType = .url
5858

5959
enum DependencyType: String, Codable, CaseIterable, ExpressibleByArgument {

‎Sources/Commands/PackageCommands/AddProduct.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ extension SwiftPackageCommand {
4141
@OptionGroup(visibility: .hidden)
4242
var globalOptions: GlobalOptions
4343

44-
@Argument(help: "The name of the new product")
44+
@Argument(help: "The name of the new product.")
4545
var name: String
4646

47-
@Option(help: "The type of target to add")
47+
@Option(help: "The type of target to add.")
4848
var type: CommandProductType = .library
4949

5050
@Option(
5151
parsing: .upToNextOption,
52-
help: "A list of targets that are part of this product"
52+
help: "A list of targets that are part of this product."
5353
)
5454
var targets: [String] = []
5555

‎Sources/Commands/PackageCommands/AddSetting.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,19 @@ extension SwiftPackageCommand {
3333
}
3434

3535
package static let configuration = CommandConfiguration(
36-
abstract: "Add a new setting to the manifest"
36+
abstract: "Add a new setting to the manifest."
3737
)
3838

3939
@OptionGroup(visibility: .hidden)
4040
var globalOptions: GlobalOptions
4141

42-
@Option(help: "The target to add the setting to")
42+
@Option(help: "The target to add the setting to.")
4343
var target: String
4444

4545
@Option(
4646
name: .customLong("swift"),
4747
parsing: .unconditionalSingleValue,
48-
help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))"
48+
help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))."
4949
)
5050
var _swiftSettings: [String]
5151

‎Sources/Commands/PackageCommands/AddTarget.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -36,33 +36,33 @@ extension SwiftPackageCommand {
3636
}
3737

3838
package static let configuration = CommandConfiguration(
39-
abstract: "Add a new target to the manifest")
39+
abstract: "Add a new target to the manifest.")
4040

4141
@OptionGroup(visibility: .hidden)
4242
var globalOptions: GlobalOptions
4343

44-
@Argument(help: "The name of the new target")
44+
@Argument(help: "The name of the new target.")
4545
var name: String
4646

47-
@Option(help: "The type of target to add")
47+
@Option(help: "The type of target to add.")
4848
var type: TargetType = .library
4949

5050
@Option(
5151
parsing: .upToNextOption,
52-
help: "A list of target dependency names"
52+
help: "A list of target dependency names."
5353
)
5454
var dependencies: [String] = []
5555

56-
@Option(help: "The URL for a remote binary target")
56+
@Option(help: "The URL for a remote binary target.")
5757
var url: String?
5858

59-
@Option(help: "The path to a local binary target")
59+
@Option(help: "The path to a local binary target.")
6060
var path: String?
6161

62-
@Option(help: "The checksum for a remote binary target")
62+
@Option(help: "The checksum for a remote binary target.")
6363
var checksum: String?
6464

65-
@Option(help: "The testing library to use when generating test targets, which can be one of 'xctest', 'swift-testing', or 'none'")
65+
@Option(help: "The testing library to use when generating test targets, which can be one of 'xctest', 'swift-testing', or 'none'.")
6666
var testingLibrary: PackageModelSyntax.AddTarget.TestHarness = .default
6767

6868
func run(_ swiftCommandState: SwiftCommandState) throws {

‎Sources/Commands/PackageCommands/AddTargetDependency.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ import Workspace
2626
extension SwiftPackageCommand {
2727
struct AddTargetDependency: SwiftCommand {
2828
package static let configuration = CommandConfiguration(
29-
abstract: "Add a new target dependency to the manifest")
29+
abstract: "Add a new target dependency to the manifest.")
3030

3131
@OptionGroup(visibility: .hidden)
3232
var globalOptions: GlobalOptions
3333

34-
@Argument(help: "The name of the new dependency")
34+
@Argument(help: "The name of the new dependency.")
3535
var dependencyName: String
3636

37-
@Argument(help: "The name of the target to update")
37+
@Argument(help: "The name of the target to update.")
3838
var targetName: String
3939

40-
@Option(help: "The package in which the dependency resides")
40+
@Option(help: "The package in which the dependency resides.")
4141
var package: String?
4242

4343
func run(_ swiftCommandState: SwiftCommandState) throws {

‎Sources/Commands/PackageCommands/ArchiveSource.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extension SwiftPackageCommand {
2929

3030
@Option(
3131
name: [.short, .long],
32-
help: "The absolute or relative path for the generated source archive"
32+
help: "The absolute or relative path for the generated source archive."
3333
)
3434
var output: AbsolutePath?
3535

‎Sources/Commands/PackageCommands/CompletionCommand.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ extension SwiftPackageCommand {
5252
@OptionGroup(visibility: .hidden)
5353
var globalOptions: GlobalOptions
5454

55-
@Argument(help: "Type of completions to list")
55+
@Argument(help: "Type of completions to list.")
5656
var mode: Mode
5757

5858
func run(_ swiftCommandState: SwiftCommandState) async throws {

‎Sources/Commands/PackageCommands/ComputeChecksum.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ struct ComputeChecksum: SwiftCommand {
2424
@OptionGroup(visibility: .hidden)
2525
var globalOptions: GlobalOptions
2626

27-
@Argument(help: "The absolute or relative path to the binary artifact")
27+
@Argument(help: "The absolute or relative path to the binary artifact.")
2828
var path: AbsolutePath
2929

3030
func run(_ swiftCommandState: SwiftCommandState) throws {

‎Sources/Commands/SwiftBuildCommand.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ struct BuildCommandOptions: ParsableArguments {
7272
}
7373

7474
/// If the test should be built.
75-
@Flag(help: "Build both source and test targets")
75+
@Flag(help: "Build both source and test targets.")
7676
var buildTests: Bool = false
7777

7878
/// Whether to enable code coverage.
7979
@Flag(name: .customLong("code-coverage"),
8080
inversion: .prefixedEnableDisable,
81-
help: "Enable code coverage")
81+
help: "Enable code coverage.")
8282
var enableCodeCoverage: Bool = false
8383

8484
/// If the binary output path should be printed.
@@ -87,20 +87,20 @@ struct BuildCommandOptions: ParsableArguments {
8787

8888
/// Whether to output a graphviz file visualization of the combined job graph for all targets
8989
@Flag(name: .customLong("print-manifest-job-graph"),
90-
help: "Write the command graph for the build manifest as a Graphviz file")
90+
help: "Write the command graph for the build manifest as a Graphviz file.")
9191
var printManifestGraphviz: Bool = false
9292

9393
/// Whether to output a graphviz file visualization of the PIF JSON sent to Swift Build.
9494
@Flag(name: .customLong("print-pif-manifest-graph"),
95-
help: "Write the PIF JSON sent to Swift Build as a Graphviz file")
95+
help: "Write the PIF JSON sent to Swift Build as a Graphviz file.")
9696
var printPIFManifestGraphviz: Bool = false
9797

9898
/// Specific target to build.
99-
@Option(help: "Build the specified target")
99+
@Option(help: "Build the specified target.")
100100
var target: String?
101101

102102
/// Specific product to build.
103-
@Option(help: "Build the specified product")
103+
@Option(help: "Build the specified product.")
104104
var product: String?
105105

106106
/// Testing library options.
@@ -115,7 +115,7 @@ struct BuildCommandOptions: ParsableArguments {
115115
package var traits: TraitOptions
116116

117117
/// If should link the Swift stdlib statically.
118-
@Flag(name: .customLong("static-swift-stdlib"), inversion: .prefixedNo, help: "Link Swift stdlib statically")
118+
@Flag(name: .customLong("static-swift-stdlib"), inversion: .prefixedNo, help: "Link Swift stdlib statically.")
119119
public var shouldLinkStaticSwiftStdlib: Bool = false
120120
}
121121

‎Sources/Commands/SwiftRunCommand.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ struct RunCommandOptions: ParsableArguments {
6262
static func help(for value: RunCommandOptions.RunMode) -> ArgumentHelp? {
6363
switch value {
6464
case .repl:
65-
return "Launch Swift REPL for the package"
65+
return "Launch Swift REPL for the package."
6666
case .debugger:
67-
return "Launch the executable in a debugger session"
67+
return "Launch the executable in a debugger session."
6868
case .run:
69-
return "Launch the executable with the provided arguments"
69+
return "Launch the executable with the provided arguments."
7070
}
7171
}
7272
}
@@ -75,17 +75,17 @@ struct RunCommandOptions: ParsableArguments {
7575
@Flag var mode: RunMode = .run
7676

7777
/// If the executable product should be built before running.
78-
@Flag(name: .customLong("skip-build"), help: "Skip building the executable product")
78+
@Flag(name: .customLong("skip-build"), help: "Skip building the executable product.")
7979
var shouldSkipBuild: Bool = false
8080

8181
var shouldBuild: Bool { !shouldSkipBuild }
8282

8383
/// If the test should be built.
84-
@Flag(name: .customLong("build-tests"), help: "Build both source and test targets")
84+
@Flag(name: .customLong("build-tests"), help: "Build both source and test targets.")
8585
var shouldBuildTests: Bool = false
8686

8787
/// The executable product to run.
88-
@Argument(help: "The executable to run", completion: .shellCommand("swift package completion-tool list-executables"))
88+
@Argument(help: "The executable to run.", completion: .shellCommand("swift package completion-tool list-executables"))
8989
var executable: String?
9090

9191
/// Specifies the traits to build the product with.
@@ -94,7 +94,7 @@ struct RunCommandOptions: ParsableArguments {
9494

9595
/// The arguments to pass to the executable.
9696
@Argument(parsing: .captureForPassthrough,
97-
help: "The arguments to pass to the executable")
97+
help: "The arguments to pass to the executable.")
9898
var arguments: [String] = []
9999
}
100100

‎Sources/Commands/SwiftTestCommand.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ extension TestError: CustomStringConvertible {
8181

8282
struct SharedOptions: ParsableArguments {
8383
@Flag(name: .customLong("skip-build"),
84-
help: "Skip building the test target")
84+
help: "Skip building the test target.")
8585
var shouldSkipBuilding: Bool = false
8686

8787
/// The test product to use. This is useful when there are multiple test products
@@ -160,12 +160,12 @@ struct TestCommandOptions: ParsableArguments {
160160

161161
/// List the tests and exit.
162162
@Flag(name: [.customLong("list-tests"), .customShort("l")],
163-
help: "Lists test methods in specifier format")
163+
help: "Lists test methods in specifier format.")
164164
var _deprecated_shouldListTests: Bool = false
165165

166166
/// If the path of the exported code coverage JSON should be printed.
167167
@Flag(name: [.customLong("show-codecov-path"), .customLong("show-code-coverage-path"), .customLong("show-coverage-path")],
168-
help: "Print the path of the exported code coverage JSON file")
168+
help: "Print the path of the exported code coverage JSON file.")
169169
var shouldPrintCodeCovPath: Bool = false
170170

171171
var testCaseSpecifier: TestCaseSpecifier {
@@ -180,13 +180,13 @@ struct TestCommandOptions: ParsableArguments {
180180
var _testCaseSpecifier: String?
181181

182182
@Option(help: """
183-
Run test cases matching regular expression, Format: <test-target>.<test-case> \
184-
or <test-target>.<test-case>/<test>
183+
Run test cases that match a regular expression, Format: '<test-target>.<test-case>' \
184+
or '<test-target>.<test-case>/<test>'.
185185
""")
186186
var filter: [String] = []
187187

188188
@Option(name: .customLong("skip"),
189-
help: "Skip test cases matching regular expression, Example: --skip PerformanceTests")
189+
help: "Skip test cases that match regular expression, Example: '--skip PerformanceTests'.")
190190
var _testCaseSkip: [String] = []
191191

192192
/// Path where the xUnit xml file should be generated.
@@ -210,7 +210,7 @@ struct TestCommandOptions: ParsableArguments {
210210
/// Whether to enable code coverage.
211211
@Flag(name: .customLong("code-coverage"),
212212
inversion: .prefixedEnableDisable,
213-
help: "Enable code coverage")
213+
help: "Enable code coverage.")
214214
var enableCodeCoverage: Bool = false
215215

216216
/// Configure test output.

0 commit comments

Comments
 (0)