Skip to content

[Event Hub] Fix a docstring problem #13579

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 4, 2020
Merged

[Event Hub] Fix a docstring problem #13579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,9 @@ def receive_batch(self, on_event_batch, **kwargs):
For detailed partition context information, please refer to
:class:`PartitionContext<azure.eventhub.PartitionContext>`.
:type on_event_batch: Callable[~azure.eventhub.PartitionContext, List[~azure.eventhub.EventData]]
:keyword int max_batch_size: The maximum number of events in a batch passed to callback `on_event_batch`.
If the actual received number of events is larger than `max_batch_size`, the received events are divided into
batches and call the callback for each batch with up to `max_batch_size` events.
:keyword float max_wait_time: The maximum interval in seconds that the event processor will wait before
calling the callback.
If no events are received within this interval, the `on_event_batch` callback will be called
Expand Down