fix(specs): Separators are non-alphanumeric characters (generated)

algolia-bot · algolia-bot · commit 555a596c03ec · 2024-10-16T12:30:47.000Z
algolia/api-clients-automation#3978 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
diff --git a/lib/Model/Recommend/FallbackParams.php b/lib/Model/Recommend/FallbackParams.php
@@ -1820,7 +1820,7 @@ public function getSeparatorsToIndex()
     /**
      * Sets separatorsToIndex.
      *
-     * @param null|string $separatorsToIndex Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+     * @param null|string $separatorsToIndex Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
      *
      * @return self
      */
diff --git a/lib/Model/Recommend/RecommendSearchParams.php b/lib/Model/Recommend/RecommendSearchParams.php
@@ -1822,7 +1822,7 @@ public function getSeparatorsToIndex()
     /**
      * Sets separatorsToIndex.
      *
-     * @param null|string $separatorsToIndex Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+     * @param null|string $separatorsToIndex Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
      *
      * @return self
      */
diff --git a/lib/Model/Search/IndexSettings.php b/lib/Model/Search/IndexSettings.php
@@ -934,7 +934,7 @@ public function getSeparatorsToIndex()
     /**
      * Sets separatorsToIndex.
      *
-     * @param null|string $separatorsToIndex Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+     * @param null|string $separatorsToIndex Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
      *
      * @return self
      */
diff --git a/lib/Model/Search/SettingsResponse.php b/lib/Model/Search/SettingsResponse.php
@@ -940,7 +940,7 @@ public function getSeparatorsToIndex()
     /**
      * Sets separatorsToIndex.
      *
-     * @param null|string $separatorsToIndex Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+     * @param null|string $separatorsToIndex Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
      *
      * @return self
      */

Original file line number	Diff line number	Diff line change
`@@ -1820,7 +1820,7 @@ public function getSeparatorsToIndex()`
`1820`	`1820`	`/**`
`1821`	`1821`	`* Sets separatorsToIndex.`
`1822`	`1822`	`*`
`1823`		- * @param null\|string $separatorsToIndex Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
	`1823`	+ * @param null\|string $separatorsToIndex Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
`1824`	`1824`	`*`
`1825`	`1825`	`* @return self`
`1826`	`1826`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1822,7 +1822,7 @@ public function getSeparatorsToIndex()`
`1822`	`1822`	`/**`
`1823`	`1823`	`* Sets separatorsToIndex.`
`1824`	`1824`	`*`
`1825`		- * @param null\|string $separatorsToIndex Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
	`1825`	+ * @param null\|string $separatorsToIndex Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
`1826`	`1826`	`*`
`1827`	`1827`	`* @return self`
`1828`	`1828`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -934,7 +934,7 @@ public function getSeparatorsToIndex()`
`934`	`934`	`/**`
`935`	`935`	`* Sets separatorsToIndex.`
`936`	`936`	`*`
`937`		- * @param null\|string $separatorsToIndex Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
	`937`	+ * @param null\|string $separatorsToIndex Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
`938`	`938`	`*`
`939`	`939`	`* @return self`
`940`	`940`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -940,7 +940,7 @@ public function getSeparatorsToIndex()`
`940`	`940`	`/**`
`941`	`941`	`* Sets separatorsToIndex.`
`942`	`942`	`*`
`943`		- * @param null\|string $separatorsToIndex Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
	`943`	+ * @param null\|string $separatorsToIndex Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
`944`	`944`	`*`
`945`	`945`	`* @return self`
`946`	`946`	`*/`