diff --git a/README.md b/README.md index a468382..1d3f625 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Siddhi Execution Regex [![GitHub Last Commit](https://img.shields.io/github/last-commit/siddhi-io/siddhi-execution-regex.svg)](https://github.com/siddhi-io/siddhi-execution-regex/commits/master) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -The **siddhi-execution-regex extension** is a Siddhi extension that provides basic regex handling capabilities such as concat, length, replace all, etc. +The **siddhi-execution-regex extension** is a Siddhi extension that provides basic RegEx execution capabilities such as find, match, etc. For information on Siddhi and it's features refer Siddhi Documentation. diff --git a/component/src/main/java/io/siddhi/extension/execution/regex/FindFunctionExtension.java b/component/src/main/java/io/siddhi/extension/execution/regex/FindFunctionExtension.java index 5a53238..d196eef 100644 --- a/component/src/main/java/io/siddhi/extension/execution/regex/FindFunctionExtension.java +++ b/component/src/main/java/io/siddhi/extension/execution/regex/FindFunctionExtension.java @@ -94,7 +94,7 @@ examples = { @Example( syntax = "regex:find('\\d\\d(.*)WSO2', " + - "'21 products are produced by WSO2 currently') as aboutWSO2)", + "'21 products are produced by WSO2 currently')", description = "This method attempts to find the subsequence of the input.sequence " + "that matches the regex pattern, `\\d\\d(.*)WSO2`. It returns `true` " + "as a subsequence exists." diff --git a/docs/api/5.0.3.md b/docs/api/5.0.3.md index cccbbe4..fffbb58 100644 --- a/docs/api/5.0.3.md +++ b/docs/api/5.0.3.md @@ -52,7 +52,7 @@ Examples EXAMPLE 1 ``` -regex:find('\d\d(.*)WSO2', '21 products are produced by WSO2 currently') as aboutWSO2) +regex:find('\d\d(.*)WSO2', '21 products are produced by WSO2 currently') ```

This method attempts to find the subsequence of the input.sequence that matches the regex pattern, \d\d(.*)WSO2. It returns true as a subsequence exists.

diff --git a/docs/api/latest.md b/docs/api/latest.md index cccbbe4..fffbb58 100644 --- a/docs/api/latest.md +++ b/docs/api/latest.md @@ -52,7 +52,7 @@ Examples EXAMPLE 1 ``` -regex:find('\d\d(.*)WSO2', '21 products are produced by WSO2 currently') as aboutWSO2) +regex:find('\d\d(.*)WSO2', '21 products are produced by WSO2 currently') ```

This method attempts to find the subsequence of the input.sequence that matches the regex pattern, \d\d(.*)WSO2. It returns true as a subsequence exists.

diff --git a/docs/index.md b/docs/index.md index a468382..1d3f625 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ Siddhi Execution Regex [![GitHub Last Commit](https://img.shields.io/github/last-commit/siddhi-io/siddhi-execution-regex.svg)](https://github.com/siddhi-io/siddhi-execution-regex/commits/master) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -The **siddhi-execution-regex extension** is a Siddhi extension that provides basic regex handling capabilities such as concat, length, replace all, etc. +The **siddhi-execution-regex extension** is a Siddhi extension that provides basic RegEx execution capabilities such as find, match, etc. For information on Siddhi and it's features refer Siddhi Documentation.