updates locale documentation for geolocator

geocoding/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.2.1
+
+- Updates documentation related to setting the locale.
+
 ## 2.2.0
 
 - Exposes the `isPresent()` method which on Android returns `true` if the 

geocoding/lib/geocoding.dart

@@ -10,15 +10,7 @@ export 'package:geocoding_platform_interface/geocoding_platform_interface.dart';
 /// However in some situations where the supplied address could not be
 /// resolved into a single [Location], multiple [Location] instances may be
 /// returned.
-///
-/// Optionally you can specify a locale in which the results are returned.
-/// When not supplied the currently active locale of the device will be used.
-/// The `localeIdentifier` should be formatted using the syntax:
-/// [languageCode]_[countryCode] (eg. en_US or nl_NL).
-Future<List<Location>> locationFromAddress(
-  String address, {
-  String? localeIdentifier,
-}) =>
+Future<List<Location>> locationFromAddress(String address) =>
     GeocodingPlatform.instance!.locationFromAddress(
       address,
     );
@@ -30,19 +22,24 @@ Future<List<Location>> locationFromAddress(
 /// However in some situations where the supplied coordinates could not be
 /// resolved into a single [Placemark], multiple [Placemark] instances may be
 /// returned.
+Future<List<Placemark>> placemarkFromCoordinates(
+        double latitude, double longitude) =>
+    GeocodingPlatform.instance!.placemarkFromCoordinates(
+      latitude,
+      longitude,
+    );
+
+/// Overrides default locale
 ///
 /// Optionally you can specify a locale in which the results are returned.
 /// When not supplied the currently active locale of the device will be used.
 /// The `localeIdentifier` should be formatted using the syntax:
 /// [languageCode]_[countryCode] (eg. en_US or nl_NL).
-Future<List<Placemark>> placemarkFromCoordinates(
-  double latitude,
-  double longitude, {
-  String? localeIdentifier,
-}) =>
-    GeocodingPlatform.instance!.placemarkFromCoordinates(
-      latitude,
-      longitude,
+Future<void> setLocaleIdentifier(
+  String localeIdentifier,
+) =>
+    GeocodingPlatform.instance!.setLocaleIdentifier(
+      localeIdentifier,
     );
 
 /// Returns a list of [Location] instances found for the supplied address.
@@ -51,11 +48,6 @@ Future<List<Placemark>> placemarkFromCoordinates(
 /// However in some situations where the supplied address could not be
 /// resolved into a single [Location], multiple [Location] instances may be
 /// returned.
-///
-/// Optionally you can specify a locale in which the results are returned.
-/// When not supplied the currently active locale of the device will be used.
-/// The `localeIdentifier` should be formatted using the syntax:
-/// [languageCode]_[countryCode] (eg. en_US or nl_NL).
 Future<bool> isPresent({
   String? localeIdentifier,
 }) =>

geocoding/pubspec.yaml

@@ -1,6 +1,6 @@
 name: geocoding
 description: A Flutter Geocoding plugin which provides easy geocoding and reverse-geocoding features.
-version: 2.2.0
+version: 2.2.1
 repository: https://github.com/baseflow/flutter-geocoding/tree/main/geocoding
 issue_tracker: https://github.com/Baseflow/flutter-geocoding/issues
 

geocoding/test/geocoding_test.dart

@@ -47,19 +47,15 @@ class MockGeocodingPlatform extends Mock
     implements
         GeocodingPlatform {
   @override
-  Future<List<Location>> locationFromAddress(
-    String address, {
-    String? localeIdentifier,
-  }) async {
+  Future<List<Location>> locationFromAddress(String address) async {
     return [mockLocation];
   }
 
   @override
   Future<List<Placemark>> placemarkFromCoordinates(
     double latitude,
-    double longitude, {
-    String? localeIdentifier,
-  }) async {
+    double longitude,
+  ) async {
     return [mockPlacemark];
   }
 }