From ca648cc14008cf11bc46b2dcd85ce41e89158abe Mon Sep 17 00:00:00 2001 From: Bingran Hu Date: Fri, 19 Jul 2024 02:18:37 -0400 Subject: [PATCH] Updates to REAMDE.md --- components/core/src/clp/regex_utils/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/components/core/src/clp/regex_utils/README.md b/components/core/src/clp/regex_utils/README.md index 603add5ac..e0021115c 100644 --- a/components/core/src/clp/regex_utils/README.md +++ b/components/core/src/clp/regex_utils/README.md @@ -19,8 +19,8 @@ metacharacters above, CLP should use the wildcard version. ### Includes -* The translator function returns a `Result` type, which can either contain a value or an error -code. +* The translator function returns a `Result` type, which can either +contain a value or an error code. To use the translator: @@ -46,7 +46,7 @@ if (result.has_error()) { ```cpp #include -RegexToWildcardTranslatorConfig config{true, false, //...other booleans}; +RegexToWildcardTranslatorConfig config{true, false, /*...other booleans*/}; auto result = regex_to_wildcard(wildcard_str, config); // Same as above @@ -65,6 +65,12 @@ For a detailed description on the options order and usage, see the ### Custom configuration +The `RegexToWildcardTranslatorConfig` class objects are currently immutable once instantiated. The +constructor takes the following arguments in order: + +* `case_insensitive_wildcard`: to be added later along with the character set translation +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