From 6caccff6da4ec76cec9850ec4cc7bf45f48957d1 Mon Sep 17 00:00:00 2001
From: Danesh Kuruppu <dknkuruppu@gmail.com>
Date: Tue, 1 Apr 2025 23:12:03 +0530
Subject: [PATCH] Fix the API documentation

---
 ballerina/uuid.bal | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/ballerina/uuid.bal b/ballerina/uuid.bal
index a70a1fb..2354a06 100644
--- a/ballerina/uuid.bal
+++ b/ballerina/uuid.bal
@@ -164,7 +164,7 @@ public isolated function createRandomUuid() returns string {
 # string nilUUID = uuid:nilAsString();
 # ```
 #
-# + return - nil UUID
+# + return - nil UUID as a string
 public isolated function nilAsString() returns string {
     return NIL_UUID;
 }
@@ -174,7 +174,7 @@ public isolated function nilAsString() returns string {
 # uuid:Uuid nilUUID = uuid:nilAsRecord();
 # ```
 #
-# + return - nil UUID
+# + return - nil UUID as a UUID record
 public isolated function nilAsRecord() returns Uuid {
     Uuid nilUuid = {
         timeLow: 0,
@@ -194,7 +194,7 @@ public isolated function nilAsRecord() returns Uuid {
 #
 # + uuid - UUID string to be validated
 #
-# + return - true if a valied UUID, false if not
+# + return - true if a valid UUID, false if not
 public isolated function validate(string uuid) returns boolean {
     return re`[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.isFullMatch(uuid);
 }