Skip to content

Commit ce16597

Browse files
committed
Refactor comparison operators documentation for clarity and consistency. Updated descriptions for contains, containsAny, beginsWith, doesNotBeginsWith, endsWith, doesNotEndsWith, in, and notIn operators to ensure uniformity in phrasing and added missing colons for better readability.
1 parent 3a03bfd commit ce16597

File tree

1 file changed

+10
-34
lines changed

1 file changed

+10
-34
lines changed

docs/search-and-query/comparison-operators.md

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -249,39 +249,15 @@ The `notBetween` operator checks datetime values and returns entities whose rele
249249

250250
### contains
251251

252-
The `contains` operator compares string properties based on the target property type:
253-
254-
<Tabs values={[
255-
{label: "String property", value: "stringProp"},
256-
{label: "Array property", value: "arrayProp"}
257-
]}>
258-
259-
<TabItem value="stringProp">
260-
When used on a string property, the operator will check if the value is contained inside the property:
252+
The `contains` operator checks if the specified value exists within a string property:
261253

262254
```json showLineNumbers
263255
{
264256
"property": "myStringProperty",
265-
"operator": "myStringProperty",
266-
"value": "mySubString"
267-
}
268-
```
269-
270-
</TabItem>
271-
272-
<TabItem value="arrayProp">
273-
When used on a string array property, the operator will check if the value is equal to one of the strings in the array:
274-
275-
```json showLineNumbers
276-
{
277-
"property": "myStringArrayProp",
278257
"operator": "contains",
279-
"value": "myString"
258+
"value": "mySubString"
280259
}
281260
```
282-
</TabItem>
283-
284-
</Tabs>
285261

286262
### doesNotContains
287263

@@ -297,7 +273,7 @@ The `contains` operator checks if the specified value **does not** exists in the
297273

298274
### containsAny
299275

300-
The `containsAny` operator checks if **any** of the specified strings exist in the target array:
276+
The `containsAny` operator checks if **any** of the specified strings exist in the target **array**:
301277

302278
```json showLineNumbers
303279
{
@@ -309,7 +285,7 @@ The `containsAny` operator checks if **any** of the specified strings exist in t
309285

310286
### beginsWith
311287

312-
The `beginsWith` operator checks if the specified property starts with the specified value**
288+
The `beginsWith` operator checks if the specified property starts with the specified value:
313289

314290
```json showLineNumbers
315291
{
@@ -321,7 +297,7 @@ The `beginsWith` operator checks if the specified property starts with the speci
321297

322298
### doesNotBeginsWith
323299

324-
The `doesNotBeginsWith` operator checks if the specified property **does not** start with the specified value
300+
The `doesNotBeginsWith` operator checks if the specified property **does not** start with the specified value:
325301

326302
```json showLineNumbers
327303
{
@@ -333,7 +309,7 @@ The `doesNotBeginsWith` operator checks if the specified property **does not** s
333309

334310
### endsWith
335311

336-
The `endsWith` operator checks if the specified property ends with the specified value
312+
The `endsWith` operator checks if the specified property ends with the specified value:
337313

338314
```json showLineNumbers
339315
{
@@ -345,7 +321,7 @@ The `endsWith` operator checks if the specified property ends with the specified
345321

346322
### doesNotEndsWith
347323

348-
The `doesNotEndsWith` operator checks if the specified property **does not** end with the specified value
324+
The `doesNotEndsWith` operator checks if the specified property **does not** end with the specified value:
349325

350326
```json showLineNumbers
351327
{
@@ -357,7 +333,7 @@ The `doesNotEndsWith` operator checks if the specified property **does not** end
357333

358334
### in
359335

360-
The `in` operator checks if a `string` property is equal to one or more specified `string` values
336+
The `in` operator checks if a `string` property is equal to one or more specified `string` values:
361337

362338
<Tabs values={[
363339
{label: "Standard", value: "array"},
@@ -378,7 +354,7 @@ The `in` operator checks if a `string` property is equal to one or more specifie
378354

379355
<TabItem value="myTeamsDynamicFilter">
380356

381-
In order to filter entities that **belong to one or more of your teams** you can use the special `My Teams` filter.
357+
In order to filter entities that **belong to one or more of your teams** you can use the special `My Teams` filter:
382358

383359
```json showLineNumbers
384360
{
@@ -398,7 +374,7 @@ You can also use the `My Teams` filter in the UI:
398374

399375
### notIn
400376

401-
The `notIn` operator checks if a `string` property is **not equal** to all of the specified `string` values
377+
The `notIn` operator checks if a `string` property is **not equal** to all of the specified `string` values:
402378

403379
```json showLineNumbers
404380
{

0 commit comments

Comments
 (0)