Skip to content

Commit

Permalink
[EventHubs] Preview release doc fix (#17166)
Browse files Browse the repository at this point in the history
  • Loading branch information
yunhaoling authored Mar 8, 2021
1 parent ce83ac1 commit 773e48b
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion sdk/eventhub/azure-eventhub/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This version and all future versions will require Python 2.7 or Python 3.6+, Pyt
events that are published.
- `EventHubProducerClient` constructor accepts two new parameters for idempotent publishing:
- `enable_idempotent_partitions`: A boolean value to tell the `EventHubProducerClient` whether to enable idempotency.
- `partition_configs`: The set of configurations that can be specified to influence publishing behavior
- `partition_config`: The set of configurations that can be specified to influence publishing behavior
specific to the configured Event Hub partition.
- Introduced a new method `get_partition_publishing_properties` on `EventHubProducerClient` to inspect the information
about the state of publishing for a partition.
Expand Down
5 changes: 5 additions & 0 deletions sdk/eventhub/azure-eventhub/doc/azure.eventhub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,16 @@ azure.eventhub package
:members:
:undoc-members:
:inherited-members:

.. autoclass:: azure.eventhub.LoadBalancingStrategy
:members:
:undoc-members:
:inherited-members:

.. autoclass:: azure.eventhub.PartitionPublishingConfiguration
:members:
:undoc-members:
:inherited-members:

Subpackages
-----------
Expand Down
6 changes: 3 additions & 3 deletions sdk/eventhub/azure-eventhub/migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide is intended to assist in the migration to `azure-eventhub` v5 from v1. It will focus on side-by-side comparisons for similar operations between the two packages.

Familiarity with the `azure-eventhub` v1 package is assumed. For those new to the Event Hubs client library for Python, please refer to the [README for `azure-eventhub`](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/README.md) rather than this guide.
Familiarity with the `azure-eventhub` v1 package is assumed. For those new to the Event Hubs client library for Python, please refer to the [README for `azure-eventhub`](https://github.com/Azure/azure-sdk-for-python/blob/feature/eventhub/idempotent-producer/sdk/eventhub/azure-eventhub/README.md) rather than this guide.

## Table of contents

Expand Down Expand Up @@ -39,7 +39,7 @@ We have a variety of new features in version 5 of the Event Hubs library.
- Ability to configure the retry policy used by operations on the clients.
- Authentication with AAD credentials using [`azure-identity`](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/identity/azure-identity/README.md).

Refer to the [changelog](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/CHANGELOG.md) for more new features, changes and bug fixes.
Refer to the [changelog](https://github.com/Azure/azure-sdk-for-python/blob/feature/eventhub/idempotent-producer/sdk/eventhub/azure-eventhub/CHANGELOG.md) for more new features, changes and bug fixes.

## Important changes

Expand Down Expand Up @@ -288,4 +288,4 @@ if __name__ == '__main__':

## Additional samples

More examples can be found at [Samples for azure-eventhub](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples)
More examples can be found at [Samples for azure-eventhub](https://github.com/Azure/azure-sdk-for-python/tree/feature/eventhub/idempotent-producer/sdk/eventhub/azure-eventhub/samples)
2 changes: 1 addition & 1 deletion sdk/eventhub/azure-eventhub/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ There, you can also find detailed instructions for using the Azure CLI, Azure Po

1. Install the Azure Event Hubs client library for Python with [pip](https://pypi.org/project/pip/):
```bash
pip install azure-eventhub
pip install azure-eventhub --pre
```

To run samples that utilize the Azure Active Directory for authentication, please install the `azure-identity` library:
Expand Down

0 comments on commit 773e48b

Please sign in to comment.