Skip to content

Commit 81f49c9

Browse files
committed
Update help menu description and parameter naming.
1 parent 475d4a7 commit 81f49c9

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Sources/SwiftDocCUtilities/ArgumentParsing/Subcommands/DiffDocCArchive.swift

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ extension Docc.ProcessArchive {
2121
/// Command line configuration.
2222
static var configuration = CommandConfiguration(
2323
commandName: "diff-docc-archive",
24-
abstract: "Produce a list of symbols added in the newer DocC Archive that did not exist in the initial DocC Archive.",
24+
abstract: "Produce a markdown file saved as {FrameworkName}_ChangeLog.md containing the diff of added/removed symbols between the two provided DocC archives.",
2525
shouldDisplay: true)
2626

2727
/// Content of the 'changeLog' template.
2828
static func changeLogTemplateFileContent(
2929
frameworkName: String,
30-
initialDocCArchiveName: String,
31-
newerDocCArchiveName: String,
30+
initialDocCArchiveVersion: String,
31+
newerDocCArchiveVersion: String,
3232
additionLinks: String,
3333
removalLinks: String
3434
) -> [String : String] {
@@ -44,19 +44,19 @@ extension Docc.ProcessArchive {
4444
4545
Browse notable changes in \(frameworkName.localizedCapitalized).
4646
47-
## Version: Diff between \(initialDocCArchiveName) and \(newerDocCArchiveName)
47+
## Version: Diff between \(initialDocCArchiveVersion) and \(newerDocCArchiveVersion)
4848
4949
5050
### Change Log
5151
5252
#### Additions
53-
_New symbols added in \(newerDocCArchiveName) that did not previously exist in \(initialDocCArchiveName)._
53+
_New symbols added in \(newerDocCArchiveVersion) that did not previously exist in \(initialDocCArchiveVersion)._
5454
5555
\(additionLinks)
5656
5757
5858
#### Removals
59-
_Old symbols that existed in \(initialDocCArchiveName) that no longer exist in \(newerDocCArchiveName)._
59+
_Old symbols that existed in \(initialDocCArchiveVersion) that no longer exist in \(newerDocCArchiveVersion)._
6060
6161
\(removalLinks)
6262
@@ -68,9 +68,9 @@ extension Docc.ProcessArchive {
6868

6969
@Argument(
7070
help: ArgumentHelp(
71-
"The name of the initial DocC Archive to be compared.",
72-
valueName: "initialDocCArchiveName"))
73-
var initialDocCArchiveName: String
71+
"The version of the initial DocC Archive to be compared.",
72+
valueName: "initialDocCArchiveVersion"))
73+
var initialDocCArchiveVersion: String
7474

7575
@Argument(
7676
help: ArgumentHelp(
@@ -81,9 +81,9 @@ extension Docc.ProcessArchive {
8181

8282
@Argument(
8383
help: ArgumentHelp(
84-
"The name of the newer DocC Archive to be compared.",
85-
valueName: "newerDocCArchiveName"))
86-
var newerDocCArchiveName: String
84+
"The version of the newer DocC Archive to be compared.",
85+
valueName: "newerDocCArchiveVersion"))
86+
var newerDocCArchiveVersion: String
8787

8888
@Argument(
8989
help: ArgumentHelp(
@@ -142,7 +142,7 @@ extension Docc.ProcessArchive {
142142
}
143143

144144
// Create markdown file with changes in the newer DocC Archive that do not exist in the initial DocC Archive.
145-
for fileNameAndContent in Docc.ProcessArchive.DiffDocCArchive.changeLogTemplateFileContent(frameworkName: frameworkName, initialDocCArchiveName: initialDocCArchiveName, newerDocCArchiveName: newerDocCArchiveName, additionLinks: additionLinks, removalLinks: removalLinks) {
145+
for fileNameAndContent in Docc.ProcessArchive.DiffDocCArchive.changeLogTemplateFileContent(frameworkName: frameworkName, initialDocCArchiveVersion: initialDocCArchiveVersion, newerDocCArchiveVersion: newerDocCArchiveVersion, additionLinks: additionLinks, removalLinks: removalLinks) {
146146
let fileName = fileNameAndContent.key
147147
let content = fileNameAndContent.value
148148
try FileManager.default.createFile(at: initialDocCArchivePath.deletingLastPathComponent().appendingPathComponent(fileName), contents: Data(content.utf8))

0 commit comments

Comments
 (0)