doc: document when GrpcNumChannelsOption applies (#10000)

googleapis · Oct 8, 2022 · dd47583 · dd47583
1 parent 7b98883
commit dd47583
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/google/cloud/grpc_options.h b/google/cloud/grpc_options.h
@@ -41,6 +41,13 @@ struct GrpcCredentialOption {
  * 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.
+ *
+ * @note This option only applies when passed to the following functions:
+ * - `bigtable::MakeDataConnection()`
+ * - `pubsub::MakePublisherConnection()`
+ * - `pubsub::MakeSubscriberConnection()`
+ * - `spanner::MakeConnection()`
+ * - `storage_experimental::DefaultGrpcClient()`
  */
 struct GrpcNumChannelsOption {
   using Type = int;