Skip to content

Commit 41fe144

Browse files
committed
fix: add more descriptive docs for parameters
1 parent d57ad8f commit 41fe144

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

packages/recommend/src/types/TrendingFacetsQuery.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type TrendingFacetsQuery = {
1515
readonly maxRecommendations?: number;
1616

1717
/**
18-
* Used for trending model
18+
* The facet attribute to get recommendations for.
1919
*/
2020
readonly facetName: string;
2121
};

packages/recommend/src/types/TrendingItemsQuery.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ export type TrendingItemsQuery = {
2929
readonly fallbackParameters?: RecommendSearchOptions;
3030

3131
/**
32-
* Used for trending model
32+
* The facet attribute to get recommendations for.
3333
*/
3434
readonly facetName?: string;
3535

3636
/**
37-
* Used for trending model
37+
* The value of the target facet.
3838
*/
3939
readonly facetValue?: string;
4040
};

0 commit comments

Comments
 (0)