Skip to content

Commit 2a5c116

Browse files
committed
Add clarification for language parameter of PlacesQuery
1 parent c47d9a6 commit 2a5c116

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

Sources/AlgoliaSearchClient/Models/Places/PlacesQuery.swift

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,33 @@ public struct PlacesQuery {
1616
public var type: PlaceType?
1717

1818
/// If specified, restrict the search results to a specific list of countries.
19-
/// Engine default: Search on the whole planet.
19+
/// - Engine default: Search on the whole planet.
2020
public var countries: [Country]?
2121

2222
/// Force to first search around a specific latitude longitude.
2323
public var aroundLatLng: Point?
2424

2525
/// Whether or not to first search around the geolocation of the user found via his IP address.
26-
/// Engine default: true
26+
/// - Engine default: true
2727
public var aroundLatLngViaIP: Bool?
2828

2929
/// Radius in meters to search around the latitude/longitude.
3030
/// Otherwise a default radius is automatically computed given the area density.
3131
public var aroundRadius: AroundRadius?
3232

3333
/// Controls whether the _rankingInfo object should be included in the hits.
34-
/// Engine default: false
34+
/// - Engine default: false
3535
public var getRankingInfo: Bool?
3636

3737
/// Specifies how many results you want to retrieve per search.
38-
/// Engine default: 20
38+
/// - Engine default: 20
3939
public var hitsPerPage: Int?
4040

41+
/// Specifies the language of the results.
42+
///
43+
/// When set to nil, engine returns the results in all available languages
44+
/// - Remark: Cannot be set explicitly. To set the language of places query, set the `language` parameter of `PlaceClients.search` method.
45+
/// - Engine default: nil
4146
internal var language: Language?
4247

4348
public init(_ query: String? = nil) {

0 commit comments

Comments
 (0)