Skip to content

Commit af2df81

Browse files
Add more defaults to descriptions
1 parent c539908 commit af2df81

File tree

1 file changed

+14
-8
lines changed
  • x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext

1 file changed

+14
-8
lines changed

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,25 +138,27 @@ public QueryString(
138138
name = "allow_leading_wildcard",
139139
type = "boolean",
140140
valueHint = { "true", "false" },
141-
description = "If true, the wildcard characters * and ? are allowed as the first character of the query string."
141+
description = "If true, the wildcard characters * and ? are allowed as the first character of the query string. "
142+
+ "Defaults to true."
142143
),
143144
@MapParam.MapParamEntry(
144145
name = "allow_wildcard",
145146
type = "boolean",
146147
valueHint = { "false", "true" },
147-
description = "If true, the query attempts to analyze wildcard terms in the query string."
148+
description = "If true, the query attempts to analyze wildcard terms in the query string. Defaults to false. "
148149
),
149150
@MapParam.MapParamEntry(
150151
name = "analyzer",
151152
type = "keyword",
152153
valueHint = { "standard" },
153-
description = "Analyzer used to convert the text in the query value into token."
154+
description = "Analyzer used to convert the text in the query value into token. "
155+
+ "Defaults to the index-time analyzer mapped for the default_field."
154156
),
155157
@MapParam.MapParamEntry(
156158
name = "auto_generate_synonyms_phrase_query",
157159
type = "boolean",
158160
valueHint = { "true", "false" },
159-
description = "If true, match phrase queries are automatically created for multi-term synonyms."
161+
description = "If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true."
160162
),
161163
@MapParam.MapParamEntry(
162164
name = "fuzziness",
@@ -204,13 +206,15 @@ public QueryString(
204206
name = "fuzzy_transpositions",
205207
type = "boolean",
206208
valueHint = { "true", "false" },
207-
description = "If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba)."
209+
description = "If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). "
210+
+ "Defaults to true."
208211
),
209212
@MapParam.MapParamEntry(
210213
name = "lenient",
211214
type = "boolean",
212215
valueHint = { "true", "false" },
213-
description = "If false, format-based errors, such as providing a text query value for a numeric field, are returned."
216+
description = "If false, format-based errors, such as providing a text query value for a numeric field, are returned. "
217+
+ "Defaults to false."
214218
),
215219
@MapParam.MapParamEntry(
216220
name = "max_determinized_states",
@@ -228,13 +232,15 @@ public QueryString(
228232
name = "quote_analyzer",
229233
type = "keyword",
230234
valueHint = { "standard" },
231-
description = "Analyzer used to convert quoted text in the query string into tokens."
235+
description = "Analyzer used to convert quoted text in the query string into tokens. "
236+
+ "Defaults to the search_quote_analyzer mapped for the default_field."
232237
),
233238
@MapParam.MapParamEntry(
234239
name = "phrase_slop",
235240
type = "integer",
236241
valueHint = { "0" },
237-
description = "Maximum number of positions allowed between matching tokens for phrases."
242+
description = "Maximum number of positions allowed between matching tokens for phrases. "
243+
+ "Defaults to 0 (which means exact matches are required)."
238244
),
239245
@MapParam.MapParamEntry(
240246
name = "quote_field_suffix",

0 commit comments

Comments
 (0)