Merge pull request #411 from daneshk/main

daneshk · web-flow · commit 3abb4e164c7f · 2023-03-29T11:15:15.000+05:30
Add deprecate message in the API Docs
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-Ballerina Regex Library
+Ballerina Regex Library [DEPRECATED]
 ==============================
 
   [![Build](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/build-timestamped-master.yml/badge.svg)](https://github.com/ballerina-platform/module-ballerina-regex/actions/workflows/build-timestamped-master.yml)
@@ -8,6 +8,8 @@ Ballerina Regex Library
   [![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerina-regex.svg)](https://github.com/ballerina-platform/module-ballerina-regex/commits/main)
   [![Github issues](https://img.shields.io/github/issues/ballerina-platform/ballerina-standard-library/module/regex.svg?label=Open%20Issues)](https://github.com/ballerina-platform/ballerina-standard-library/labels/module%2Fregex)
 
+**Deprecation Notice:** This library is deprecated and will no longer be maintained or updated. We recommend that you migrate to [ballerina/lang.regexp](https://lib.ballerina.io/ballerina/lang.regexp/latest) library for continued support and updates.
+
 This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a
 regular expression as a `String` to perform these operations by finding the string matches.
 
diff --git a/ballerina/Module.md b/ballerina/Module.md
@@ -1,3 +1,5 @@
+**Deprecation Notice:** This library is deprecated and will no longer be maintained or updated. We recommend that you migrate to [ballerina/lang.regexp](https://lib.ballerina.io/ballerina/lang.regexp/latest) library for continued support and updates.
+
 ## Overview
 
 This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a 
diff --git a/ballerina/Package.md b/ballerina/Package.md
@@ -1,3 +1,5 @@
+**Deprecation Notice:** This library is deprecated and will no longer be maintained or updated. We recommend that you migrate to [ballerina/lang.regexp](https://lib.ballerina.io/ballerina/lang.regexp/latest) library for continued support and updates.
+
 ## Package overview
 
 This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+Deprecation Notice: This library is deprecated and will no longer be maintained or updated. We recommend that you migrate to [ballerina/lang.regexp](https://lib.ballerina.io/ballerina/lang.regexp/latest) library for continued support and updates.`
	`2`	`+`
`1`	`3`	`## Overview`
`2`	`4`
`3`	`5`	`This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+Deprecation Notice: This library is deprecated and will no longer be maintained or updated. We recommend that you migrate to [ballerina/lang.regexp](https://lib.ballerina.io/ballerina/lang.regexp/latest) library for continued support and updates.`
	`2`	`+`
`1`	`3`	`## Package overview`
`2`	`4`
`3`	`5`	`This module provides APIs for searching, splitting, and replacing the set of characters of a string. These APIs are using a`