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

Typo in generated code comment: "pancis" should be "panics" in Register<foo>Server #7828

Closed
chrisclapham opened this issue Nov 12, 2024 · 1 comment
Labels
Area: Codegen Includes anything related to protoc-gen-go-grpc. Status: Obsolete Type: Bug

Comments

@chrisclapham
Copy link

What version of gRPC are you using?

google.golang.org/grpc v1.67.1
protoc-gen-go-grpc 1.5.1

What version of Go are you using (go version)?

go version go1.23.1 windows/amd64

What operating system (Linux, Windows, …) and version?

Microsoft Windows [Version 10.0.26100.2033]

What did you do?

I noticed a typo in the generated Go code comments from protoc-gen-go-grpc.

To reproduce:

  1. Create a simple .proto file with a service definition:
syntax = "proto3";

package example;
option go_package = "/examplepb";

message EmptyMessage {}

service ExampleService {
  rpc Example (EmptyMessage) returns (EmptyMessage) {}
}
  1. Generate the Go code using protoc with protoc-gen-go-grpc
  2. Examine the generated *_grpc.pb.go file

What did you expect to see?

// If the following call panics, it indicates UnimplementedServicesServer was...

What did you see instead?

// If the following call pancis, it indicates UnimplementedServicesServer was...

This is a minor documentation issue that doesn't affect functionality, but should be fixed for clarity and correctness. Thanks team.

@arjan-bal
Copy link
Contributor

Hi @chrisclapham, thanks for reporting the issue. The typo is fixed in #7456. The fix will be a part of the next protoc-gen-go-grpc release, i.e. v1.6.0. There is no ETA for the release at the moment.

@arjan-bal arjan-bal added Status: Obsolete Area: Codegen Includes anything related to protoc-gen-go-grpc. labels Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Codegen Includes anything related to protoc-gen-go-grpc. Status: Obsolete Type: Bug
Projects
None yet
Development

No branches or pull requests

2 participants