Merge pull request #4 from Nuvindu/docs

Update the documentation in the standard format
ballerina-platform · Apr 10, 2024 · a558e98 · a558e98
2 parents 0aef599 + 46a593f
commit a558e98
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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.