Skip to content
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.

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

doc.go: Move package after package comment #25

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

evanj
Copy link
Collaborator

@evanj evanj commented Jun 4, 2024

This detailed package comment is not being recognized by Go as a package comment because it needs to come immediately before the package statement. This should make this comment appear on pkg.go.dev. Fixes staticcheck warnings:

doc.go:1:1: at least one file in a package should have a package comment (ST1000)

This detailed package comment is not being recognized by Go as a
package comment because it needs to come immediately before the
package statement. This should make this comment appear on
pkg.go.dev. Fixes staticcheck warnings:

doc.go:1:1: at least one file in a package should have a package comment (ST1000)
@evanj evanj merged commit c87374b into master Jun 5, 2024
1 check passed
@evanj evanj deleted the evan.jones/package-comment branch June 5, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants