Skip to content

Commit

Permalink
fix(specs): adjust style for banner descriptions (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#4362

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
  • Loading branch information
3 people committed Jan 16, 2025
1 parent 9e85fbd commit 801173e
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* a search banner with image and url.
* Banner with image and link to redirect users.
*
* @param image
* @param link
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* image of a search banner.
* Image to show inside a banner.
*
* @param urls
* @param title
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* url for a search banner image.
* URL for an image to show inside a banner.
*
* @param url
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* link for a banner defined in merchandising studio.
* Link for a banner defined in the Merchandising Studio.
*
* @param url
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* 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.
* @param banners Banners defined in the Merchandising Studio for a given search.
*/
@Serializable
public data class Widgets(

/** banners defined in the merchandising studio for the given search. */
/** Banners defined in the Merchandising Studio for a given search. */
@SerialName(value = "banners") val banners: List<Banner>? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* a search banner with image and url.
* Banner with image and link to redirect users.
*
* @param image
* @param link
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* image of a search banner.
* Image to show inside a banner.
*
* @param urls
* @param title
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* url for a search banner image.
* URL for an image to show inside a banner.
*
* @param url
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* link for a banner defined in merchandising studio.
* Link for a banner defined in the Merchandising Studio.
*
* @param url
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* 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.
* @param banners Banners defined in the Merchandising Studio for a given search.
*/
@Serializable
public data class Widgets(

/** banners defined in the merchandising studio for the given search. */
/** Banners defined in the Merchandising Studio for a given search. */
@SerialName(value = "banners") val banners: List<Banner>? = null,
)

0 comments on commit 801173e

Please sign in to comment.