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.

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

Update the documentation in the standard format #4

Merged
merged 3 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Ballerina Avro module provides the capability to efficiently serialize and d

## Schema

The `Schema` instance takes an Avro schema in `string` format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.
The `Schema` instance accepts an Avro schema in `string` format. If the provided schema is not valid according to Avro, an error is returned. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.

A `Schema` can be defined using the `string` value of an Avro schema as shown below.

Expand Down
2 changes: 1 addition & 1 deletion ballerina/Module.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Ballerina Avro module provides the capability to efficiently serialize and d

## Schema

The `Schema` instance takes an Avro schema in `string` format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.
The `Schema` instance accepts an Avro schema in `string` format. If the provided schema is not valid according to Avro, an error is returned. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.

A `Schema` can be defined using the `string` value of an Avro schema as shown below.

Expand Down
2 changes: 1 addition & 1 deletion ballerina/Package.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Ballerina Avro module provides the capability to efficiently serialize and d

## Schema

The `Schema` instance takes an Avro schema in `string` format. And will return an error if the schema is not a valid Avro schema. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.
The `Schema` instance accepts an Avro schema in `string` format. If the provided schema is not valid according to Avro, an error is returned. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.

A `Schema` can be defined using the `string` value of an Avro schema as shown below.

Expand Down
Loading