fix(specs): Cross-reference filerPromotes to relevant guide (generated)

algolia/api-clients-automation#5279

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: gazconroy <[email protected]>
Co-authored-by: Gary Conroy <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: 4 people

Sources/Search/Models/SearchConsequence.swift

@@ -13,9 +13,11 @@ public struct SearchConsequence: Codable, JSONEncodable {
     /// Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either
     /// individually, or as groups of up to 100 records each.
     public var promote: [SearchPromote]?
-    /// Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user
-    /// actions (filtering the search) are given a higher precendence. For example, if you promote a record with the
-    /// `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won't be shown.
+    /// Determines whether promoted records must also match active filters for the consequence to apply.  This ensures
+    /// user-applied filters take priority and irrelevant matches aren't shown. For example, if you promote a record
+    /// with `color: red` but the user filters for `color: blue`, the \"red\" record won't be shown.  > In the Algolia
+    /// dashboard, when you use the **Pin an item** consequence, `filterPromotes` appears as the checkbox: **Pinned
+    /// items must match active filters to be displayed.** For examples, see [Promote results with rules](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits/#promote-results-matching-active-filters).
     public var filterPromotes: Bool?
     /// Records you want to hide from the search results.
     public var hide: [SearchConsequenceHide]?