From e92ad0190a7fec48a587889b4e4a02139bc51648 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 16 Jan 2025 22:17:37 +0000 Subject: [PATCH] fix(specs): adjust style for banner descriptions (generated) https://github.com/algolia/api-clients-automation/pull/4362 Co-authored-by: algolia-bot Co-authored-by: Kai Welke Co-authored-by: Pierre Millot --- src/main/scala/algoliasearch/recommend/Banner.scala | 2 +- src/main/scala/algoliasearch/recommend/BannerImage.scala | 2 +- src/main/scala/algoliasearch/recommend/BannerImageUrl.scala | 2 +- src/main/scala/algoliasearch/recommend/BannerLink.scala | 2 +- src/main/scala/algoliasearch/recommend/Widgets.scala | 4 ++-- src/main/scala/algoliasearch/search/Banner.scala | 2 +- src/main/scala/algoliasearch/search/BannerImage.scala | 2 +- src/main/scala/algoliasearch/search/BannerImageUrl.scala | 2 +- src/main/scala/algoliasearch/search/BannerLink.scala | 2 +- src/main/scala/algoliasearch/search/Widgets.scala | 4 ++-- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/scala/algoliasearch/recommend/Banner.scala b/src/main/scala/algoliasearch/recommend/Banner.scala index e1db1958..9b0ac997 100644 --- a/src/main/scala/algoliasearch/recommend/Banner.scala +++ b/src/main/scala/algoliasearch/recommend/Banner.scala @@ -29,7 +29,7 @@ */ package algoliasearch.recommend -/** a search banner with image and url. +/** Banner with image and link to redirect users. */ case class Banner( image: Option[BannerImage] = scala.None, diff --git a/src/main/scala/algoliasearch/recommend/BannerImage.scala b/src/main/scala/algoliasearch/recommend/BannerImage.scala index 29f4b791..ee2e4a8d 100644 --- a/src/main/scala/algoliasearch/recommend/BannerImage.scala +++ b/src/main/scala/algoliasearch/recommend/BannerImage.scala @@ -29,7 +29,7 @@ */ package algoliasearch.recommend -/** image of a search banner. +/** Image to show inside a banner. */ case class BannerImage( urls: Option[Seq[BannerImageUrl]] = scala.None, diff --git a/src/main/scala/algoliasearch/recommend/BannerImageUrl.scala b/src/main/scala/algoliasearch/recommend/BannerImageUrl.scala index 54b2851c..ddf32748 100644 --- a/src/main/scala/algoliasearch/recommend/BannerImageUrl.scala +++ b/src/main/scala/algoliasearch/recommend/BannerImageUrl.scala @@ -29,7 +29,7 @@ */ package algoliasearch.recommend -/** url for a search banner image. +/** URL for an image to show inside a banner. */ case class BannerImageUrl( url: Option[String] = scala.None diff --git a/src/main/scala/algoliasearch/recommend/BannerLink.scala b/src/main/scala/algoliasearch/recommend/BannerLink.scala index b5906464..a3f8ae1a 100644 --- a/src/main/scala/algoliasearch/recommend/BannerLink.scala +++ b/src/main/scala/algoliasearch/recommend/BannerLink.scala @@ -29,7 +29,7 @@ */ package algoliasearch.recommend -/** link for a banner defined in merchandising studio. +/** Link for a banner defined in the Merchandising Studio. */ case class BannerLink( url: Option[String] = scala.None diff --git a/src/main/scala/algoliasearch/recommend/Widgets.scala b/src/main/scala/algoliasearch/recommend/Widgets.scala index 8d06a322..64cd1403 100644 --- a/src/main/scala/algoliasearch/recommend/Widgets.scala +++ b/src/main/scala/algoliasearch/recommend/Widgets.scala @@ -29,10 +29,10 @@ */ package algoliasearch.recommend -/** widgets returned from any rules that are applied to the current search. +/** Widgets returned from any rules that are applied to the current search. * * @param banners - * banners defined in the merchandising studio for the given search. + * Banners defined in the Merchandising Studio for a given search. */ case class Widgets( banners: Option[Seq[Banner]] = scala.None diff --git a/src/main/scala/algoliasearch/search/Banner.scala b/src/main/scala/algoliasearch/search/Banner.scala index 37dca001..452fbe4a 100644 --- a/src/main/scala/algoliasearch/search/Banner.scala +++ b/src/main/scala/algoliasearch/search/Banner.scala @@ -33,7 +33,7 @@ */ package algoliasearch.search -/** a search banner with image and url. +/** Banner with image and link to redirect users. */ case class Banner( image: Option[BannerImage] = scala.None, diff --git a/src/main/scala/algoliasearch/search/BannerImage.scala b/src/main/scala/algoliasearch/search/BannerImage.scala index 9f219cd5..2b728129 100644 --- a/src/main/scala/algoliasearch/search/BannerImage.scala +++ b/src/main/scala/algoliasearch/search/BannerImage.scala @@ -33,7 +33,7 @@ */ package algoliasearch.search -/** image of a search banner. +/** Image to show inside a banner. */ case class BannerImage( urls: Option[Seq[BannerImageUrl]] = scala.None, diff --git a/src/main/scala/algoliasearch/search/BannerImageUrl.scala b/src/main/scala/algoliasearch/search/BannerImageUrl.scala index a20d6ae6..b0bc1bdd 100644 --- a/src/main/scala/algoliasearch/search/BannerImageUrl.scala +++ b/src/main/scala/algoliasearch/search/BannerImageUrl.scala @@ -33,7 +33,7 @@ */ package algoliasearch.search -/** url for a search banner image. +/** URL for an image to show inside a banner. */ case class BannerImageUrl( url: Option[String] = scala.None diff --git a/src/main/scala/algoliasearch/search/BannerLink.scala b/src/main/scala/algoliasearch/search/BannerLink.scala index 14be8619..55d314f5 100644 --- a/src/main/scala/algoliasearch/search/BannerLink.scala +++ b/src/main/scala/algoliasearch/search/BannerLink.scala @@ -33,7 +33,7 @@ */ package algoliasearch.search -/** link for a banner defined in merchandising studio. +/** Link for a banner defined in the Merchandising Studio. */ case class BannerLink( url: Option[String] = scala.None diff --git a/src/main/scala/algoliasearch/search/Widgets.scala b/src/main/scala/algoliasearch/search/Widgets.scala index 72202cc7..217aa61a 100644 --- a/src/main/scala/algoliasearch/search/Widgets.scala +++ b/src/main/scala/algoliasearch/search/Widgets.scala @@ -33,10 +33,10 @@ */ package algoliasearch.search -/** widgets returned from any rules that are applied to the current search. +/** Widgets returned from any rules that are applied to the current search. * * @param banners - * banners defined in the merchandising studio for the given search. + * Banners defined in the Merchandising Studio for a given search. */ case class Widgets( banners: Option[Seq[Banner]] = scala.None