From 17fa8212056e98e667529086eafe875502e1ebb2 Mon Sep 17 00:00:00 2001 From: David Brunow Date: Mon, 28 Jul 2025 07:58:40 -0500 Subject: [PATCH] chore: fix documentation grammar and parameter references --- CHANGELOG.md | 18 ------------------ Sources/GitClient/GitClient.swift | 5 ++--- Sources/Model/GitCommit.swift | 2 +- 3 files changed, 3 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1220a68..2aa6c71 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,21 +14,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * Setup CI for releases (9b70416) * Add CI (31581ad) -## [0.1.0] - 2024-05-20 - -### Features -* Initial implementation of parsing (0c04db6) - -### Chores -* Setup CI for releases (9b70416) -* Add CI (31581ad) - -## [0.1.0] - 2024-05-20 - -### Features -* Initial implementation of parsing (0c04db6) - -### Chores -* Setup CI for releases (9b70416) -* Add CI (31581ad) - diff --git a/Sources/GitClient/GitClient.swift b/Sources/GitClient/GitClient.swift index 6725087..170e6ac 100644 --- a/Sources/GitClient/GitClient.swift +++ b/Sources/GitClient/GitClient.swift @@ -10,8 +10,7 @@ public struct GitClient { /// Returns the results of the `git log` command as an array of `GitCommit` that represent the /// commits in a git repository. - /// - Parameter tag: An optional tag that, when provided, will run the `git log` command from - /// HEAD to that tag. + /// - Parameter targetBranch: The target branch to compare against. public func commitsSinceBranch(targetBranch: String) -> [GitCommit] { _log(.branch(targetBranch)) } @@ -35,7 +34,7 @@ public struct GitClient { /// Initializes a `GitClient`. /// - Parameters: - /// - log: A closure that takes an optional `String` and returns an array of `GitCommit`. + /// - log: A closure that takes a LogType and returns an array of `GitCommit`. /// - tag: A closure that returns an array of `String` representing git tags. public init( log: @escaping (LogType) -> [GitCommit], diff --git a/Sources/Model/GitCommit.swift b/Sources/Model/GitCommit.swift index fcefb52..894e940 100644 --- a/Sources/Model/GitCommit.swift +++ b/Sources/Model/GitCommit.swift @@ -30,7 +30,7 @@ public struct GitCommit: Equatable { } /// Parses a specially formatted git commit produced by git log. - /// - Parameter rawString: A string produces by the `git log` command using this format: + /// - Parameter rawString: A string produced by the `git log` command using this format: /// `--pretty="%h @-@-@-@-@ %s @-@-@-@-@ %b"` public init?(_ rawString: String) { let components = rawString.components(separatedBy: ParsingConstants.fieldSeparator)