diff --git a/docs/src/dev-guide/components-core/index.md b/docs/src/dev-guide/components-core/index.md index 0e9fd2623..62360486a 100644 --- a/docs/src/dev-guide/components-core/index.md +++ b/docs/src/dev-guide/components-core/index.md @@ -91,6 +91,7 @@ centos7.4-deps-install macos12-deps-install ubuntu-focal-deps-install ubuntu-jammy-deps-install +regex-utils ::: [feature-req]: https://github.com/y-scope/clp/issues/new?assignees=&labels=enhancement&template=feature-request.yml diff --git a/components/core/src/clp/regex_utils/README.md b/docs/src/dev-guide/components-core/regex-utils.md similarity index 86% rename from components/core/src/clp/regex_utils/README.md rename to docs/src/dev-guide/components-core/regex-utils.md index 9a4f461df..a7ec16774 100644 --- a/components/core/src/clp/regex_utils/README.md +++ b/docs/src/dev-guide/components-core/regex-utils.md @@ -1,4 +1,4 @@ -# Regex_utils +# regex_utils library This library contains useful utilities to handle all regex related tasks. @@ -58,10 +58,10 @@ For a detailed description on the options order and usage, see the ### Functionalities * Wildcards - - Turn `.` into `?` - - Turn `.*` into `*` - - Turn `.+` into `?*` - - E.g. `abc.*def.ghi.+` will get translated to `abc*def?ghi?*` + * Turn `.` into `?` + * Turn `.*` into `*` + * Turn `.+` into `?*` + * E.g. `abc.*def.ghi.+` will get translated to `abc*def?ghi?*` ### Custom configuration @@ -69,9 +69,9 @@ The `RegexToWildcardTranslatorConfig` class objects are currently immutable once constructor takes the following arguments in order: * `case_insensitive_wildcard`: to be added later along with the character set translation -implementation. + implementation. * `add_prefix_suffix_wildcards`: in the absence of regex anchors, add prefix or suffix wildcards so -the query becomes a substring query. - - E.g. `info.*system` gets translated into `*info*system*` which makes the original query a - substring query. + the query becomes a substring query. + * E.g. `info.*system` gets translated into `*info*system*` which makes the original query a + substring query.