fix: add more descriptive docs for parameters

algolia · Dec 19, 2022 · 41fe144 · 41fe144
1 parent d57ad8f
commit 41fe144
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/packages/recommend/src/types/TrendingFacetsQuery.ts b/packages/recommend/src/types/TrendingFacetsQuery.ts
@@ -15,7 +15,7 @@ export type TrendingFacetsQuery = {
   readonly maxRecommendations?: number;
 
   /**
-   * Used for trending model
+   * The facet attribute to get recommendations for.
    */
   readonly facetName: string;
 };
diff --git a/packages/recommend/src/types/TrendingItemsQuery.ts b/packages/recommend/src/types/TrendingItemsQuery.ts
@@ -29,12 +29,12 @@ export type TrendingItemsQuery = {
   readonly fallbackParameters?: RecommendSearchOptions;
 
   /**
-   * Used for trending model
+   * The facet attribute to get recommendations for.
    */
   readonly facetName?: string;
 
   /**
-   * Used for trending model
+   * The value of the target facet.
    */
   readonly facetValue?: string;
 };