From 6794ea16e8aa48835bb212f2dc026387ac51a4bb Mon Sep 17 00:00:00 2001 From: Nuvindu Date: Wed, 10 Apr 2024 06:21:10 +0530 Subject: [PATCH] Update documentation --- README.md | 2 +- ballerina/Module.md | 2 +- ballerina/Package.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 372745f..cd448e9 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/ballerina/Module.md b/ballerina/Module.md index 4788206..61d8f49 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -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. diff --git a/ballerina/Package.md b/ballerina/Package.md index cbb2dbf..2f4530d 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -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.