chore: ensure that all packages have comments #547
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.
Branched off #546, and will conflict once that has been landed
This mirrors an internal linter, though this linter requires that the package comment be in a file that is not ignored e.g. due to
go:build
conditions, meaning it considers a few packages as missing comments as they're in a Windows-only file.Currently, I've addressed that by copying the comment into a non-Windows file without removing the previous comment, though we might want to discuss what convention we actually follow - I think there's at least two possible ones to consider:
go:build
"set" i.e.xyz_dummy.go
andxyz_windows.go
(downside being we're having to maintain the comment twice)Relates to #455
Relates to #274