Address review suggestions

ballerina-platform · Oct 21, 2024 · bac1a43 · bac1a43
1 parent 87e14b6
commit bac1a43
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 18 deletions.
diff --git a/examples/index.json b/examples/index.json
@@ -1218,8 +1218,8 @@
         "isLearnByExample": true
       },
       {
-        "name": "RegExp operations",
-        "url": "regexp-operations",
+        "name": "RegExp operations overview",
+        "url": "regexp_operations_overview",
         "verifyBuild": true,
         "verifyOutput": true,
         "isLearnByExample": true

diff --git a/...s/regexp-operations/regexp_operations.bal → ...operations/regexp_operations_overview.bal b/...s/regexp-operations/regexp_operations.bal → ...operations/regexp_operations_overview.bal
diff --git a/...es/regexp-operations/regexp_operations.md → ...-operations/regexp_operations_overview.md b/...es/regexp-operations/regexp_operations.md → ...-operations/regexp_operations_overview.md
@@ -2,9 +2,9 @@
 
 The ``RegExp`` type supports a set of langlib functions to search and manipulate string values.
 
-::: code regexp_operations.bal :::
+::: code regexp_operations_overview.bal :::
 
-::: out regexp_operations.out :::
+::: out regexp_operations_overview.out :::
 
 ## Related links
 - [RegExp type](/learn/by-example/regexp-type)

diff --git a/...exp-operations/regexp_operations.metatags → ...tions/regexp_operations_overview.metatags b/...exp-operations/regexp_operations.metatags → ...tions/regexp_operations_overview.metatags
diff --git a/...s/regexp-operations/regexp_operations.out → ...operations/regexp_operations_overview.out b/...s/regexp-operations/regexp_operations.out → ...operations/regexp_operations_overview.out
diff --git a/examples/regexp-replace-operations/regexp_replace_operations.bal b/examples/regexp-replace-operations/regexp_replace_operations.bal
@@ -3,21 +3,16 @@ import ballerina/io;
 public function main() {
     string creditCardNumber = "1234-5678-9876-5432";
     string:RegExp pattern = re `(\d{4})-(\d{4})-(\d{4})`;
-    // Replaces the first occurrence of the credit card pattern with a masked representation.
+    // Replace the first occurrence of the credit card pattern with a masked representation.
     string maskedCardNumber = pattern.replace(creditCardNumber, "****-****-****");
     io:println(maskedCardNumber);
 
-    string xmlString = "<root>" +
-            "<!-- This is a comment -->" +
-            "<element1>Value 1</element1>" +
-            "<element2>Value 2</element2>" +
-            "<!-- Another comment -->" +
-            "<element3>Value 3</element3>" +
-        "</root>";
+    xml xmlString = 
+            xml `<root><!--comment 1 --><e1>value1</e1><e2>value2</e2><!--comment 2-->></root>`;
 
-    // Regular expression to match XML comments
+    // Regular expression to match XML comments.
     string:RegExp commentPattern = re `<!--.*?-->`;
-    // Replaces all occurrences of XML comments with an empty string, effectively removing them.
-    string commentsRemoved = commentPattern.replaceAll(xmlString, "");
-    io:println(string `Comments removed XML: ${commentsRemoved}`);
+    // Replace all occurrences of XML comments with an empty string, effectively removing them.
+    string commentsRemovedXml = commentPattern.replaceAll(xmlString.toString(), "");
+    io:println("XML string with comments removed: ", commentsRemovedXml);
 }
diff --git a/examples/regexp-replace-operations/regexp_replace_operations.md b/examples/regexp-replace-operations/regexp_replace_operations.md
@@ -1,6 +1,6 @@
 # RegExp operations
 
-The ``RegExp`` type supports a set of anguage library functions for replacing patterns in strings.
+The `RegExp` type supports a set of langlib functions to replace parts of strings that match specific patterns.
 
 ::: code regexp_replace_operations.bal :::
 

diff --git a/examples/regexp-replace-operations/regexp_replace_operations.out b/examples/regexp-replace-operations/regexp_replace_operations.out
@@ -1,3 +1,3 @@
 $ bal run regexp_replace_operations.bal
 ****-****-****-5432
-Comments removed XML: <root><element1>Value 1</element1><element2>Value 2</element2><element3>Value 3</element3></root>
+XML string with comments removed: <root><e1>value1</e1><e2>value2</e2>&gt;</root>