Add codegen comment to protoc-gen-go-helpers outputs #132
Conversation
This file contains 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
This way GitHub automatically marks them as generated files and will hide their diffs in PRs by default
dnr
approved these changes
Nov 22, 2023
cmd/protoc-gen-go-helpers/main.go
Outdated
| @@ -59,7 +59,7 @@ type ( | |||
| const ( | |||
| msgImport = "google.golang.org/protobuf/proto" | |||
| enumImport = "fmt" | |||
| headerTmpl = ` | |||
| headerTmpl = `// Code generated by protoc-gen-go-helpers. DO NOT EDIT. | |||
There was a problem hiding this comment.
I'd add a blank line in between just so it doesn't look like a doc comment on the package
dnr
reviewed
Nov 22, 2023
| @@ -60,6 +60,7 @@ const ( | |||
| msgImport = "google.golang.org/protobuf/proto" | |||
| enumImport = "fmt" | |||
| headerTmpl = ` | |||
| // Code generated by protoc-gen-go-helpers. DO NOT EDIT. | |||
There was a problem hiding this comment.
I meant in between the comment and the package line. I believe godoc interprets a comment on package as documentation for the package itself
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.
What changed?
I added a comment to all files generated by protoc-gen-go-helpers that GitHub can use to ID them as generated
Why?
This way GitHub automatically marks them as generated files and will hide their diffs in PRs by default
How did you test it?
I ran it
Potential risks
None