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.

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

[SchemaRegistry] docs fix #22992

Merged
merged 1 commit into from
Feb 9, 2022
Merged

[SchemaRegistry] docs fix #22992

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion sdk/eventhub/azure-eventhub/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
author_email='[email protected]',
url='https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventhub/azure-eventhub',
classifiers=[
"Development Status :: 5 - Production/Stable",
"Development Status :: 4 - Beta",
'Programming Language :: Python',
'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3.6',
Expand Down
8 changes: 4 additions & 4 deletions sdk/schemaregistry/azure-schemaregistry-avroencoder/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ If message type or callback function is not provided, and by default, the encode
The following sections provide several code snippets covering some of the most common Schema Registry tasks, including:

- [Encoding](#encoding)
- [Deencoding](#decoding)
- [Decoding](#decoding)
- [Event Hubs Sending Integration](#event-hubs-sending-integration)
- [Event Hubs Receiving Integration](#event-hubs-receiving-integration)

### Encoding

Use `AvroEncoder.encode` method to encode dict data with the given avro schema.
Use `AvroEncoder.encode` method to encode dict data with the given Avro schema.
The method will use a schema previously registered to the Schema Registry service and keep the schema cached for future encoding usage. It is also possible to avoid pre-registering the schema to the service and automatically register with the `encode` method by instantiating the `AvroEncoder` with the keyword argument `auto_register_schemas=True`.

```python
Expand Down Expand Up @@ -175,7 +175,7 @@ with encoder:

### Event Hubs Sending Integration

Integration with [Event Hubs][eventhubs_repo] to send encoded avro dict data as the body of EventData.
Integration with [Event Hubs][eventhubs_repo] to send encoded Avro dict data as the body of EventData.

```python
import os
Expand Down Expand Up @@ -219,7 +219,7 @@ with eventhub_producer, avro_encoder:

### Event Hubs Receiving Integration

Integration with [Event Hubs][eventhubs_repo] to receive `EventData` and decoded raw bytes into avro dict data.
Integration with [Event Hubs][eventhubs_repo] to receive `EventData` and decoded raw bytes into Avro dict data.

```python
import os
Expand Down
2 changes: 1 addition & 1 deletion sdk/schemaregistry/azure-schemaregistry-avroencoder/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ pip install azure-eventhub==5.9.0b1

1. Open a terminal window and `cd` to the directory that the samples are saved in.
2. Set the environment variables specified in the sample file you wish to run.
3. Follow the usage described in the file, e.g. `python avro_encoder.py`
3. Follow the usage described in the file, e.g. `python encode_and_decode_event_data_message.py`

## Next steps

Expand Down