From 148c751bc336c38df9d7a71685e6747399b4100f Mon Sep 17 00:00:00 2001 From: Bingran Hu Date: Thu, 25 Jul 2024 01:33:51 -0400 Subject: [PATCH] Update README --- docs/src/dev-guide/components-core/regex-utils.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/src/dev-guide/components-core/regex-utils.md b/docs/src/dev-guide/components-core/regex-utils.md index c0f022a7a..b79f0a729 100644 --- a/docs/src/dev-guide/components-core/regex-utils.md +++ b/docs/src/dev-guide/components-core/regex-utils.md @@ -82,16 +82,18 @@ For a detailed description on the options order and usage, see the * A trivial character set containing a single character or a single escaped metacharacter. * E.g. `[a]` into `a`, `[\^]` into `^` * If the `case_insensitive_wildcard` config is turned on, the translator can also reduce the - following patterns into a single lowercase character: + case-insensitive style character set patterns into a single lowercase character: * E.g. `[aA]` into `a`, `[Bb]` into `b`, `[xX][Yy][zZ]` into `xyz` ### Custom configuration -The `RegexToWildcardTranslatorConfig` class objects are currently immutable once instantiated. The -constructor takes the following arguments in order: +The `RegexToWildcardTranslatorConfig` class objects are currently immutable once instantiated. By +default, all of the options are set to `false`. -* `case_insensitive_wildcard`: see *Character set* bullet point in the [Functionalities] - (#functionalities) section. +The constructor takes the following option arguments in order: + +* `case_insensitive_wildcard`: see **Character set** bullet point in the + [Functionalities](#functionalities) section. * `add_prefix_suffix_wildcards`: in the absence of regex anchors, add prefix or suffix wildcards so the query becomes a substring query.