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

protoc gen adds comment, does not follow godoc. #7350

Closed
titpetric opened this issue Jun 25, 2024 · 5 comments
Closed

protoc gen adds comment, does not follow godoc. #7350

titpetric opened this issue Jun 25, 2024 · 5 comments

Comments

@titpetric
Copy link

titpetric commented Jun 25, 2024

For the service interface a comment is added to the generated interface, as seen on #3794

// GreeterServer is the server API for Greeter service.
// All implementations must embed UnimplementedGreeterServer
// for forward compatibility

This appended comment violates godoc as it does not end with punctuation (dot).

Expected:

// GreeterServer is the server API for Greeter service.
// All implementations must embed UnimplementedGreeterServer
// for forward compatibility.

Is there a way we can:

  • turn off this comment (flags?),
  • modify this comment on our own (flags?),
  • just get the dot added in a future release?

Thank you for understanding :D

@purnesh42H purnesh42H self-assigned this Jun 26, 2024
@purnesh42H
Copy link
Contributor

@titpetric we can fix this by adding punctuation in protoc generation here https://github.com/grpc/grpc-go/blob/master/cmd/protoc-gen-go-grpc/grpc.go#L267 and then regenerate all pb.go files. Do you want to give a try for fix?

@purnesh42H
Copy link
Contributor

purnesh42H commented Jun 28, 2024

@titpetric just checking in if you will be doing a fix PR for this

@titpetric
Copy link
Author

titpetric commented Jun 28, 2024

@infovivek2020 beat me to it :) 🫡✅

@arjan-bal
Copy link
Contributor

Assigning to @purnesh42H since @infovivek2020 isn't showing up as an option to set as the assignee.

@infovivek2020
Copy link
Contributor

@purnesh42H I have raised PR #7392 the please review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants