Skip to content

Commit 5e2d5f7

Browse files
docs(README): automatic update
Update README Swift [This list might not be relevant] docs: Fix `removeStopWords` query parameter - Properly document the dual type. - Improve description. [ci skip]
1 parent a689e6d commit 5e2d5f7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1368,20 +1368,20 @@ A string that contains the comma separated list of words that should be consider
13681368
#### removeStopWords
13691369
13701370
- scope: `settings`, `search`
1371-
- type: `boolean`
1371+
- type: `boolean`, `array of strings`
13721372
- default: `false`
13731373
13741374
1375-
Remove stop words from the query **before** executing it. Defaults to `false`.
1376-
Use a boolean to enable/disable all 41 supported languages and a comma separated list
1377-
of iso codes of the languages you want to use consider to enable the stopwords removal
1378-
on a subset of them (select the one you have in your records).
1375+
Remove stop words from the query **before** executing it. It can be:
1376+
1377+
- a **boolean**: enable or disable stop words for all 41 supported languages; or
1378+
- a **list of language ISO codes** (as a comma-separated string) for which stop words should be enabled.
13791379
1380-
In most use-cases, **you shouldn't need to enable this option**.
1380+
In most use-cases, **we don’t recommend enabling this option**.
13811381
1382-
List of 41 supported languages with their associated iso code: Arabic=ar, Armenian=hy, Basque=eu, Bengali=bn, Brazilian=pt-br, Bulgarian=bg, Catalan=ca, Chinese=zh, Czech=cs, Danish=da, Dutch=nl, English=en, Finnish=fi, French=fr, Galician=gl, German=de, Greek=el, Hindi=hi, Hungarian=hu, Indonesian=id, Irish=ga, Italian=it, Japanese=ja, Korean=ko, Kurdish=ku, Latvian=lv, Lithuanian=lt, Marathi=mr, Norwegian=no, Persian (Farsi)=fa, Polish=pl, Portugese=pt, Romanian=ro, Russian=ru, Slovak=sk, Spanish=es, Swedish=sv, Thai=th, Turkish=tr, Ukranian=uk, Urdu=ur
1382+
List of 41 supported languages with their associated iso code: Arabic=`ar`, Armenian=`hy`, Basque=`eu`, Bengali=`bn`, Brazilian=`pt-br`, Bulgarian=`bg`, Catalan=`ca`, Chinese=`zh`, Czech=`cs`, Danish=`da`, Dutch=`nl`, English=`en`, Finnish=`fi`, French=`fr`, Galician=`gl`, German=`de`, Greek=`el`, Hindi=`hi`, Hungarian=`hu`, Indonesian=`id`, Irish=`ga`, Italian=`it`, Japanese=`ja`, Korean=`ko`, Kurdish=`ku`, Latvian=`lv`, Lithuanian=`lt`, Marathi=`mr`, Norwegian=`no`, Persian (Farsi)=`fa`, Polish=`pl`, Portugese=`pt`, Romanian=`ro`, Russian=`ru`, Slovak=`sk`, Spanish=`es`, Swedish=`sv`, Thai=`th`, Turkish=`tr`, Ukranian=`uk`, Urdu=`ur`.
13831383
1384-
Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the queryType parameter:
1384+
Stop words removal is applied on query words that are not interpreted as a prefix. The behavior depends of the `queryType` parameter:
13851385
13861386
* `queryType=prefixLast` means the last query word is a prefix and it won’t be considered for stop words removal
13871387
* `queryType=prefixNone` means no query word are prefix, stop words removal will be applied on all query words

0 commit comments

Comments
 (0)