Skip to content

Commit d41d56d

Browse files
algolia-botgazconroyGary Conroyshortcuts
committed
fix(specs): Cross-reference filerPromotes to relevant guide (generated)
algolia/api-clients-automation#5279 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: gazconroy <gazconroyster@gmail.com> Co-authored-by: Gary Conroy <gary.conroy@LON-M3P-GConroy.local> Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
1 parent eb8ba32 commit d41d56d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

algoliasearch/Models/Search/Consequence.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ public Consequence() { }
3535
public List<Promote> Promote { get; set; }
3636

3737
/// <summary>
38-
/// 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.
38+
/// 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).
3939
/// </summary>
40-
/// <value>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. </value>
40+
/// <value>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). </value>
4141
[JsonPropertyName("filterPromotes")]
4242
public bool? FilterPromotes { get; set; }
4343

0 commit comments

Comments
 (0)