Skip to content

Commit ad32642

Browse files
committed
Fix keyword type display in sphinx-generated doc
1 parent 4898587 commit ad32642

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class EventHubConsumerClient(ClientBase):
9191
of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time.
9292
Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval
9393
of 10 seconds.
94-
:keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in,
94+
:keyword load_balancing_strategy: When load-balancing kicks in,
9595
it will use this strategy to claim and balance the partition ownership.
9696
Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every
9797
load-balancing evaluation, will grab as many unclaimed partitions required to balance the load.
@@ -101,6 +101,7 @@ class EventHubConsumerClient(ClientBase):
101101
too few partitions, this client will steal one partition from other clients for every load-balancing
102102
evaluation regardless of the load balancing strategy.
103103
Greedy strategy is used by default.
104+
:paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy
104105
105106
106107
.. admonition:: Example:
@@ -225,7 +226,7 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs):
225226
of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time.
226227
Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval
227228
of 10 seconds.
228-
:keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in,
229+
:keyword load_balancing_strategy: When load-balancing kicks in,
229230
it will use this strategy to claim and balance the partition ownership.
230231
Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every
231232
load-balancing evaluation, will grab as many unclaimed partitions required to balance the load.
@@ -235,6 +236,7 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs):
235236
too few partitions, this client will steal one partition from other clients for every load-balancing
236237
evaluation regardless of the load balancing strategy.
237238
Greedy strategy is used by default.
239+
:paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy
238240
239241
:rtype: ~azure.eventhub.EventHubConsumerClient
240242

sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ class EventHubConsumerClient(ClientBaseAsync):
9696
of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time.
9797
Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval
9898
of 10 seconds.
99-
:keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in,
99+
:keyword load_balancing_strategy: When load-balancing kicks in,
100100
it will use this strategy to claim and balance the partition ownership.
101101
Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every
102102
load-balancing evaluation, will grab as many unclaimed partitions required to balance the load.
@@ -106,6 +106,7 @@ class EventHubConsumerClient(ClientBaseAsync):
106106
too few partitions, this client will steal one partition from other clients for every load-balancing
107107
evaluation regardless of the load balancing strategy.
108108
Greedy strategy is used by default.
109+
:paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy
109110
110111
.. admonition:: Example:
111112
@@ -242,7 +243,7 @@ def from_connection_string(
242243
of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time.
243244
Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval
244245
of 10 seconds.
245-
:keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in,
246+
:keyword load_balancing_strategy: When load-balancing kicks in,
246247
it will use this strategy to claim and balance the partition ownership.
247248
Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every
248249
load-balancing evaluation, will grab as many unclaimed partitions required to balance the load.
@@ -252,6 +253,7 @@ def from_connection_string(
252253
too few partitions, this client will steal one partition from other clients for every load-balancing
253254
evaluation regardless of the load balancing strategy.
254255
Greedy strategy is used by default.
256+
:paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy
255257
:rtype: ~azure.eventhub.aio.EventHubConsumerClient
256258
257259
.. admonition:: Example:

0 commit comments

Comments
 (0)