Skip to content

Commit 147c4e4

Browse files
heckjheckj
committed
work in progress - help to full sentences, abstracts to full sentences.
1 parent 58fc542 commit 147c4e4

26 files changed

+120
-120
lines changed

‎Sources/Commands/PackageCommands/APIDiff.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ struct DeprecatedAPIDiff: ParsableCommand {
3838
struct APIDiff: AsyncSwiftCommand {
3939
static let configuration = CommandConfiguration(
4040
commandName: "diagnose-api-breaking-changes",
41-
abstract: "Diagnose API-breaking changes to Swift modules in a package",
41+
abstract: "Diagnose API-breaking changes to Swift modules in a package.",
4242
discussion: """
4343
The diagnose-api-breaking-changes command can be used to compare the Swift API of \
4444
a package to a baseline revision, diagnosing any breaking changes which have \

‎Sources/Commands/PackageCommands/AddDependency.swift

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

3232
@Argument(help: "The URL or directory of the package to add.")

‎Sources/Commands/PackageCommands/AddProduct.swift

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

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

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

‎Sources/Commands/PackageCommands/ArchiveSource.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ extension SwiftPackageCommand {
2121
struct ArchiveSource: AsyncSwiftCommand {
2222
static let configuration = CommandConfiguration(
2323
commandName: "archive-source",
24-
abstract: "Create a source archive for the package"
24+
abstract: "Create a source archive for the package."
2525
)
2626

2727
@OptionGroup(visibility: .hidden)

‎Sources/Commands/PackageCommands/CompletionCommand.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ extension SwiftPackageCommand {
2222
struct CompletionCommand: AsyncSwiftCommand {
2323
static let configuration = CommandConfiguration(
2424
commandName: "completion-tool",
25-
abstract: "Completion command (for shell completions)"
25+
abstract: "Command to generate shell completions."
2626
)
2727

2828
enum Mode: String, CaseIterable, ExpressibleByArgument {

‎Sources/Commands/PackageCommands/Config.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ extension SwiftPackageCommand {
3030
extension SwiftPackageCommand.Config {
3131
struct SetMirror: SwiftCommand {
3232
static let configuration = CommandConfiguration(
33-
abstract: "Set a mirror for a dependency"
33+
abstract: "Set a mirror for a dependency."
3434
)
3535

3636
@OptionGroup(visibility: .hidden)
@@ -45,10 +45,10 @@ extension SwiftPackageCommand.Config {
4545
@Option(name: .customLong("mirror-url"), help: .hidden)
4646
var _deprecate_mirrorURL: String?
4747

48-
@Option(help: "The original url or identity")
48+
@Option(help: "The original url or identity.")
4949
var original: String?
5050

51-
@Option(help: "The mirror url or identity")
51+
@Option(help: "The mirror url or identity.")
5252
var mirror: String?
5353

5454
func run(_ swiftCommandState: SwiftCommandState) throws {
@@ -88,7 +88,7 @@ extension SwiftPackageCommand.Config {
8888

8989
struct UnsetMirror: SwiftCommand {
9090
static let configuration = CommandConfiguration(
91-
abstract: "Remove an existing mirror"
91+
abstract: "Remove an existing mirror."
9292
)
9393

9494
@OptionGroup(visibility: .hidden)
@@ -103,10 +103,10 @@ extension SwiftPackageCommand.Config {
103103
@Option(name: .customLong("mirror-url"), help: .hidden)
104104
var _deprecate_mirrorURL: String?
105105

106-
@Option(help: "The original url or identity")
106+
@Option(help: "The original url or identity.")
107107
var original: String?
108108

109-
@Option(help: "The mirror url or identity")
109+
@Option(help: "The mirror url or identity.")
110110
var mirror: String?
111111

112112
func run(_ swiftCommandState: SwiftCommandState) throws {
@@ -143,7 +143,7 @@ extension SwiftPackageCommand.Config {
143143

144144
struct GetMirror: SwiftCommand {
145145
static let configuration = CommandConfiguration(
146-
abstract: "Print mirror configuration for the given package dependency"
146+
abstract: "Print mirror configuration for the given package dependency."
147147
)
148148

149149
@OptionGroup(visibility: .hidden)
@@ -154,7 +154,7 @@ extension SwiftPackageCommand.Config {
154154
@Option(name: .customLong("original-url"), help: .hidden)
155155
var _deprecate_originalURL: String?
156156

157-
@Option(help: "The original url or identity")
157+
@Option(help: "The original url or identity.")
158158
var original: String?
159159

160160
func run(_ swiftCommandState: SwiftCommandState) throws {

‎Sources/Commands/PackageCommands/Describe.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ import struct TSCBasic.StringError
2323
extension SwiftPackageCommand {
2424
struct Describe: AsyncSwiftCommand {
2525
static let configuration = CommandConfiguration(
26-
abstract: "Describe the current package")
27-
26+
abstract: "Describe the current package.")
27+
2828
@OptionGroup(visibility: .hidden)
2929
var globalOptions: GlobalOptions
3030

31-
@Option(help: "Set the output format")
31+
@Option(help: "Set the output format.")
3232
var type: DescribeMode = .text
3333

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

‎Sources/Commands/PackageCommands/DumpCommands.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import XCBuildSupport
2323

2424
struct DumpSymbolGraph: AsyncSwiftCommand {
2525
static let configuration = CommandConfiguration(
26-
abstract: "Dump Symbol Graph")
26+
abstract: "Dump symbol graphs.")
2727
static let defaultMinimumAccessLevel = SymbolGraphExtract.AccessLevel.public
2828

2929
@OptionGroup(visibility: .hidden)
@@ -35,7 +35,7 @@ struct DumpSymbolGraph: AsyncSwiftCommand {
3535
@Flag(help: "Skip members inherited through classes or default implementations.")
3636
var skipSynthesizedMembers = false
3737

38-
@Option(help: "Include symbols with this access level or more. Possible values: \(SymbolGraphExtract.AccessLevel.allValueStrings.joined(separator: " | "))")
38+
@Option(help: "Include symbols with this access level or more. Possible values: \(SymbolGraphExtract.AccessLevel.allValueStrings.joined(separator: " | ")).")
3939
var minimumAccessLevel = defaultMinimumAccessLevel
4040

4141
@Flag(help: "Skip emitting doc comments for members inherited through classes or default implementations.")

‎Sources/Commands/PackageCommands/EditCommands.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ import Workspace
1919
extension SwiftPackageCommand {
2020
struct Edit: AsyncSwiftCommand {
2121
static let configuration = CommandConfiguration(
22-
abstract: "Put a package in editable mode")
22+
abstract: "Put a package in editable mode.")
2323

2424
@OptionGroup(visibility: .hidden)
2525
var globalOptions: GlobalOptions
2626

27-
@Option(help: "The revision to edit", transform: { Revision(identifier: $0) })
27+
@Option(help: "The revision to edit.", transform: { Revision(identifier: $0) })
2828
var revision: Revision?
2929

30-
@Option(name: .customLong("branch"), help: "The branch to create")
30+
@Option(name: .customLong("branch"), help: "The branch to create.")
3131
var checkoutBranch: String?
3232

33-
@Option(help: "Create or use the checkout at this path")
33+
@Option(help: "Create or use the checkout at this path.")
3434
var path: AbsolutePath?
3535

36-
@Argument(help: "The identity of the package to edit")
36+
@Argument(help: "The identity of the package to edit.")
3737
var packageIdentity: String
3838

3939
func run(_ swiftCommandState: SwiftCommandState) async throws {
@@ -53,16 +53,16 @@ extension SwiftPackageCommand {
5353

5454
struct Unedit: AsyncSwiftCommand {
5555
static let configuration = CommandConfiguration(
56-
abstract: "Remove a package from editable mode")
56+
abstract: "Remove a package from editable mode.")
5757

5858
@OptionGroup(visibility: .hidden)
5959
var globalOptions: GlobalOptions
6060

6161
@Flag(name: .customLong("force"),
62-
help: "Unedit the package even if it has uncommitted and unpushed changes")
62+
help: "Unedit the package even if it has uncommitted and unpushed changes.")
6363
var shouldForceRemove: Bool = false
6464

65-
@Argument(help: "The identity of the package to unedit")
65+
@Argument(help: "The identity of the package to unedit.")
6666
var packageIdentity: String
6767

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

‎Sources/Commands/PackageCommands/Format.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ extension SwiftPackageCommand {
3131
var globalOptions: GlobalOptions
3232

3333
@Argument(parsing: .captureForPassthrough,
34-
help: "Pass flag through to the swift-format tool")
34+
help: "Pass flag through to the swift-format tool.")
3535
var swiftFormatFlags: [String] = []
3636

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

‎Sources/Commands/PackageCommands/Init.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import SPMBuildCore
2323
extension SwiftPackageCommand {
2424
struct Init: SwiftCommand {
2525
public static let configuration = CommandConfiguration(
26-
abstract: "Initialize a new package")
26+
abstract: "Initialize a new package.")
2727

2828
@OptionGroup(visibility: .hidden)
2929
var globalOptions: GlobalOptions
@@ -47,7 +47,7 @@ extension SwiftPackageCommand {
4747
@OptionGroup()
4848
var testLibraryOptions: TestLibraryOptions
4949

50-
@Option(name: .customLong("name"), help: "Provide custom package name")
50+
@Option(name: .customLong("name"), help: "Provide custom package name.")
5151
var packageName: String?
5252

5353
// This command should support creating the supplied --package-path if it isn't created.

‎Sources/Commands/PackageCommands/Install.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ extension SwiftPackageCommand {
3030
@OptionGroup()
3131
var globalOptions: GlobalOptions
3232

33-
@Option(help: "The name of the executable product to install")
33+
@Option(help: "The name of the executable product to install.")
3434
var product: String?
3535

3636
func run(_ commandState: SwiftCommandState) async throws {

‎Sources/Commands/PackageCommands/Learn.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ extension SwiftPackageCommand {
2323
@OptionGroup()
2424
var globalOptions: GlobalOptions
2525

26-
static let configuration = CommandConfiguration(abstract: "Learn about Swift and this package")
26+
static let configuration = CommandConfiguration(abstract: "Learn about Swift and this package.")
2727

2828
func files(fileSystem: FileSystem, in directory: AbsolutePath, fileExtension: String? = nil) throws -> [AbsolutePath] {
2929
guard fileSystem.isDirectory(directory) else {

‎Sources/Commands/PackageCommands/PluginCommand.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,28 +25,28 @@ import Workspace
2525
struct PluginCommand: AsyncSwiftCommand {
2626
static let configuration = CommandConfiguration(
2727
commandName: "plugin",
28-
abstract: "Invoke a command plugin or perform other actions on command plugins"
28+
abstract: "Invoke a command plugin or perform other actions on command plugins."
2929
)
3030

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

3434
@Flag(
3535
name: .customLong("list"),
36-
help: "List the available command plugins"
36+
help: "List the available command plugins."
3737
)
3838
var listCommands: Bool = false
3939

4040
struct PluginOptions: ParsableArguments {
4141
@Flag(
4242
name: .customLong("allow-writing-to-package-directory"),
43-
help: "Allow the plugin to write to the package directory"
43+
help: "Allow the plugin to write to the package directory."
4444
)
4545
var allowWritingToPackageDirectory: Bool = false
4646

4747
@Option(
4848
name: .customLong("allow-writing-to-directory"),
49-
help: "Allow the plugin to write to an additional directory"
49+
help: "Allow the plugin to write to an additional directory."
5050
)
5151
var additionalAllowedWritableDirectories: [String] = []
5252

@@ -123,20 +123,20 @@ struct PluginCommand: AsyncSwiftCommand {
123123

124124
@Option(
125125
name: .customLong("package"),
126-
help: "Limit available plugins to a single package with the given identity"
126+
help: "Limit available plugins to a single package with the given identity."
127127
)
128128
var packageIdentity: String? = nil
129129
}
130130

131131
@OptionGroup()
132132
var pluginOptions: PluginOptions
133133

134-
@Argument(help: "Verb of the command plugin to invoke")
134+
@Argument(help: "Verb of the command plugin to invoke.")
135135
var command: String = ""
136136

137137
@Argument(
138138
parsing: .captureForPassthrough,
139-
help: "Arguments to pass to the command plugin"
139+
help: "Arguments to pass to the command plugin."
140140
)
141141
var arguments: [String] = []
142142

‎Sources/Commands/PackageCommands/ResetCommands.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import Workspace
1717
extension SwiftPackageCommand {
1818
struct Clean: SwiftCommand {
1919
static let configuration = CommandConfiguration(
20-
abstract: "Delete build artifacts")
20+
abstract: "Delete build artifacts.")
2121

2222
@OptionGroup(visibility: .hidden)
2323
var globalOptions: GlobalOptions
@@ -41,7 +41,7 @@ extension SwiftPackageCommand {
4141

4242
struct Reset: AsyncSwiftCommand {
4343
static let configuration = CommandConfiguration(
44-
abstract: "Reset the complete cache/build directory")
44+
abstract: "Reset the complete cache/build directory.")
4545

4646
@OptionGroup(visibility: .hidden)
4747
var globalOptions: GlobalOptions

‎Sources/Commands/PackageCommands/Resolve.swift

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ import struct PackageGraph.TraitConfiguration
2020

2121
extension SwiftPackageCommand {
2222
struct ResolveOptions: ParsableArguments {
23-
@Option(help: "The version to resolve at", transform: { Version($0) })
23+
@Option(help: "The version to resolve at.", transform: { Version($0) })
2424
var version: Version?
2525

26-
@Option(help: "The branch to resolve at")
26+
@Option(help: "The branch to resolve at.")
2727
var branch: String?
2828

29-
@Option(help: "The revision to resolve at")
29+
@Option(help: "The revision to resolve at.")
3030
var revision: String?
3131

32-
@Argument(help: "The name of the package to resolve")
32+
@Argument(help: "The name of the package to resolve.")
3333
var packageName: String?
3434

3535
/// Specifies the traits to build.
@@ -39,7 +39,7 @@ extension SwiftPackageCommand {
3939

4040
struct Resolve: AsyncSwiftCommand {
4141
static let configuration = CommandConfiguration(
42-
abstract: "Resolve package dependencies")
42+
abstract: "Resolve package dependencies.")
4343

4444
@OptionGroup(visibility: .hidden)
4545
var globalOptions: GlobalOptions

‎Sources/Commands/PackageCommands/ShowDependencies.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ import var TSCBasic.stdoutStream
2323
extension SwiftPackageCommand {
2424
struct ShowDependencies: AsyncSwiftCommand {
2525
static let configuration = CommandConfiguration(
26-
abstract: "Print the resolved dependency graph")
26+
abstract: "Print the resolved dependency graph.")
2727

2828
@OptionGroup(visibility: .hidden)
2929
var globalOptions: GlobalOptions
3030

31-
@Option(help: "Set the output format")
31+
@Option(help: "Set the output format.")
3232
var format: ShowDependenciesMode = .text
3333

3434
@Option(name: [.long, .customShort("o") ],

‎Sources/Commands/PackageCommands/SwiftPackageCommand.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public struct SwiftPackageCommand: AsyncParsableCommand {
2929
public static var configuration = CommandConfiguration(
3030
commandName: "package",
3131
_superCommandName: "swift",
32-
abstract: "Perform operations on Swift packages",
32+
abstract: "Perform operations on Swift packages.",
3333
discussion: "SEE ALSO: swift build, swift run, swift test",
3434
version: SwiftVersion.current.completeDisplayString,
3535
subcommands: [

‎Sources/Commands/PackageCommands/ToolsVersionCommand.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ import Workspace
2121
struct ToolsVersionCommand: SwiftCommand {
2222
static let configuration = CommandConfiguration(
2323
commandName: "tools-version",
24-
abstract: "Manipulate tools version of the current package")
24+
abstract: "Manipulate tools version of the current package.")
2525

2626
@OptionGroup(visibility: .hidden)
2727
var globalOptions: GlobalOptions
2828

29-
@Flag(help: "Set tools version of package to the current tools version in use")
29+
@Flag(help: "Set tools version of package to the current tools version in use.")
3030
var setCurrent: Bool = false
3131

32-
@Option(help: "Set tools version of package to the given value")
32+
@Option(help: "Set tools version of package to the given value.")
3333
var set: String?
3434

3535
enum ToolsVersionMode {

0 commit comments

Comments
 (0)