Repository navigation
review: an own-line Go comment starts uppercase - #421
Merged
Merged
Conversation
/code sets the case by position: own-line uppercase like godoc, trailing lowercase. Comments only: a comment naming the declaration below it, and a product name, keep their case. e2e is left out.
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
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.
/codesets a comment's case by its position: an own-line comment starts uppercase like godoc, and a trailing one starts lowercase. Production Go had drifted. This commit capitalizes the first letter of the 126 own-line comments that break it.It changes only that letter: a script checks that every changed line differs from the old one by case alone. A comment that names the declaration below it (
// conns tracks…) and a product name (cocoon,silkd) keep their case, because godoc starts with the name.e2e/is left out.Stacked on #420.
Hot path: none, comments only.
Gates:
go buildon the three modules touched,go vetonpoolandegress, andgofmt -lare clean. CI runs the rest.