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

Support .proto file comments for Services #962

Closed
thomasvl opened this issue Sep 8, 2020 · 0 comments · Fixed by #1059
Closed

Support .proto file comments for Services #962

thomasvl opened this issue Sep 8, 2020 · 0 comments · Fixed by #1059
Labels
kind/enhancement Improvements to existing feature.

Comments

@thomasvl
Copy link

thomasvl commented Sep 8, 2020

Looks like Methods use the helper protoSourceComments() to get comments, but it doesn't look like the Service comments are brought over into the generated sources, likely useful to still have them.

@thomasvl thomasvl added the kind/enhancement Improvements to existing feature. label Sep 8, 2020
glbrntt added a commit to glbrntt/grpc-swift that referenced this issue Nov 30, 2020
Motivation:

It can be useful to know the service path a client is for, particularly
when constructing calls manually.

Additionally, we include the methods comments for RPCs but not the
service comments, they may be helpful in some cases.

Modifications:

- Generate the 'serviceName' for the client
- Generate the proto source comments for the client and server

Result:

- Generated code is a touch more useful
- Resolves grpc#962, grpc#1036
glbrntt added a commit that referenced this issue Dec 1, 2020
Motivation:

It can be useful to know the service path a client is for, particularly
when constructing calls manually.

Additionally, we include the methods comments for RPCs but not the
service comments, they may be helpful in some cases.

Modifications:

- Generate the 'serviceName' for the client
- Generate the proto source comments for the client and server

Result:

- Generated code is a touch more useful
- Resolves #962, #1036
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvements to existing feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant