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

Document when GrpcNumChannelsOption applies #8906

Closed
dbolduc opened this issue May 6, 2022 · 1 comment · Fixed by #10000
Closed

Document when GrpcNumChannelsOption applies #8906

dbolduc opened this issue May 6, 2022 · 1 comment · Fixed by #10000
Assignees
Labels
good first issue This issue is a good place to started contributing to this repository. type: docs Improvement to the documentation for an API.

Comments

@dbolduc
Copy link
Member

dbolduc commented May 6, 2022

/**
* The number of transport channels to create.
*
* gRPC limits the number of simultaneous calls in progress on a channel to
* 100. Increasing the number of channels thus increases the number of
* operations that can be in progress in parallel.
*/
struct GrpcNumChannelsOption {
using Type = int;
};

This option only applies in certain libraries (the handwritten ones). We should make this clear.

This means documenting the option:

@note This option only applies to a few libraries. Check the service's `*Connection` documentation for details.

... and documenting the connection pool for the Connections that use it.

@dbolduc dbolduc added good first issue This issue is a good place to started contributing to this repository. type: docs Improvement to the documentation for an API. labels May 6, 2022
@coryan
Copy link
Contributor

coryan commented Sep 21, 2022

Just fixing the existing comment seems good enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue This issue is a good place to started contributing to this repository. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants