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

Improve the documentation for generated Stub functions #339

Open
davydog187 opened this issue Nov 27, 2023 · 1 comment · May be fixed by #341
Open

Improve the documentation for generated Stub functions #339

davydog187 opened this issue Nov 27, 2023 · 1 comment · May be fixed by #341

Comments

@davydog187
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
Functions generated via use GRPC.Stub, service: MyService are not well documented. Understanding the arity and shape of expected parameters require digging into the source code to find GRPC.Stub.call/6 information. The docs currently make a vague mention to this

Describe the solution you'd like
Document how injected functions are generated so that it is easy to find

Describe alternatives you've considered
N/A

Additional context
N/A

@davydog187
Copy link
Collaborator Author

I have spoken to @polvalente about this, creating an issue first in case someone else gets to it before me. I'm planning on sending a PR

davydog187 added a commit to davydog187/grpc that referenced this issue Nov 28, 2023
Adds clarifying documentation for how functions are generated for GRPC.Stub

Closes elixir-grpc#339
@davydog187 davydog187 linked a pull request Nov 28, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant