Fix package doc comment in sqlitetest - #52
Merged
Conversation
The doc comment read "Package `sqltest` provides testing helpers for the `sql` package", but the package is `sqlitetest` and it provides helpers for the `sqlite` package. Match the convention used by `servicetest`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was found
The package doc comment in
sqlitetest/database.goread:Both halves are wrong: the package is
sqlitetest(notsqltest), and it provides testing helpers for thesqlitepackage (it importsapp/sqliteand returns*sqlite.Database), not "the sql package". The likely cause is a copy/rename that left the doc comment behind.The sibling helper package gets this right:
servicetest/service.gohas// Package servicetest provides testing helpers for the service package.What was fixed
Corrected the doc comment to match reality and the established convention:
// Package sqlitetest provides testing helpers for the sqlite package.One-line, comment-only change.
gofmt -landgo vet ./sqlitetest/are clean. A repo-wide grep forsqltestconfirms no other occurrences of the stale wording.Review notes
Clean review -- no concerns raised. Two competing reviewers independently confirmed the new comment is accurate, satisfies Go's "Package " doc convention, matches the
servicetestsibling, and introduces no new problems.