Skip to content

chore: fix documentation grammar and parameter references #54

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

Open
DavidBrunow wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: fix documentation grammar and parameter references #54

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

5 changes: 2 additions & 3 deletions Sources/GitClient/GitClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
Expand All @@ -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],
Expand Down
2 changes: 1 addition & 1 deletion Sources/Model/GitCommit.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading