From 23dea534de8225c448fb318e3836922ce9036174 Mon Sep 17 00:00:00 2001 From: Roman Cinis <52065414+tsinis@users.noreply.github.com> Date: Sun, 9 Feb 2025 00:59:47 +0100 Subject: [PATCH] refactor(pr): address @coderabbitai code review comments --- .../helpers/world_country/world_country_web_resources.dart | 4 ++-- .../sealed_countries/lib/src/model/country/submodels/idd.dart | 2 +- .../lib/src/model/country/submodels/maps.dart | 4 ++-- .../lib/src/model/regional_bloc/regional_bloc.dart | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/packages/sealed_countries/lib/src/helpers/world_country/world_country_web_resources.dart b/packages/sealed_countries/lib/src/helpers/world_country/world_country_web_resources.dart index 0fdbb3c2..f7abbfee 100644 --- a/packages/sealed_countries/lib/src/helpers/world_country/world_country_web_resources.dart +++ b/packages/sealed_countries/lib/src/helpers/world_country/world_country_web_resources.dart @@ -27,7 +27,7 @@ extension WorldCountryWebResources on WorldCountry { /// Returns the URL of the PNG image file for the country's coat of arms if it /// has one, or `null` otherwise. /// - /// If the `hasCoatOfArms` property of the [WorldCountry] object is `true`, + /// If the [hasCoatOfArms] property of the [WorldCountry] object is `true`, /// returns the URL of the PNG image file for the country's coat of arms. /// Otherwise, returns `null`. String? maybeCoatOfArmsPngUrl() => @@ -36,7 +36,7 @@ extension WorldCountryWebResources on WorldCountry { /// Returns the URL of the SVG image file for the country's coat of arms if it /// has one, or `null` otherwise. /// - /// If the `hasCoatOfArms` property of the [WorldCountry] object is `true`, + /// If the [hasCoatOfArms] property of the [WorldCountry] object is `true`, /// returns the URL of the SVG image file for the country's coat of arms. /// Otherwise, returns `null`. String? maybeCoatOfArmsSvgUrl() => diff --git a/packages/sealed_countries/lib/src/model/country/submodels/idd.dart b/packages/sealed_countries/lib/src/model/country/submodels/idd.dart index b5d49f7f..be50eaff 100644 --- a/packages/sealed_countries/lib/src/model/country/submodels/idd.dart +++ b/packages/sealed_countries/lib/src/model/country/submodels/idd.dart @@ -6,7 +6,7 @@ import "../../../helpers/extensions/country_submodels/idd_extension.dart"; /// /// The [Idd] class is a simple value object that represents an International /// Direct Dialing (IDD) code. It consists of an [int] value that represents the -/// root of the IDD code, and a `List` value that represents the [suffixes] +/// root of the IDD code, and a [List] value that represents the [suffixes] /// of the IDD code. /// /// Example usage: diff --git a/packages/sealed_countries/lib/src/model/country/submodels/maps.dart b/packages/sealed_countries/lib/src/model/country/submodels/maps.dart index 65a97093..127ced2b 100644 --- a/packages/sealed_countries/lib/src/model/country/submodels/maps.dart +++ b/packages/sealed_countries/lib/src/model/country/submodels/maps.dart @@ -5,8 +5,8 @@ import "../../../helpers/extensions/country_submodels/maps_extension.dart"; /// A class that represents URLs for Google Maps and OpenStreetMap. /// /// The [Maps] class is a simple wrapper around two string URLs for Google Maps -/// and OpenStreetMap. It provides convenience methods for generating the full -/// URLs from the URL prefixes and the map IDs. +/// and OpenStreetMap. The URL prefixes are provided as static constants, while +/// URL generation functionality is available through the [MapsExtension]. /// /// Example usage: /// diff --git a/packages/sealed_countries/lib/src/model/regional_bloc/regional_bloc.dart b/packages/sealed_countries/lib/src/model/regional_bloc/regional_bloc.dart index 5c922bb8..c8f89289 100644 --- a/packages/sealed_countries/lib/src/model/regional_bloc/regional_bloc.dart +++ b/packages/sealed_countries/lib/src/model/regional_bloc/regional_bloc.dart @@ -3,7 +3,7 @@ part of "world_bloc.dart"; /// The [RegionalBloc] class is an non-abstract class that represents a regional /// bloc. It consists of a [String] values that represents the name and acronym /// of the regional bloc. The [name] and [acronym] fields are required and must -/// not be empty. The [otherAcronyms] and [otherNames] fields are non-required. +/// not be empty. The [otherAcronyms] and [otherNames] fields are optional. /// /// Example usage: /// @@ -77,7 +77,7 @@ class RegionalBloc extends WorldBloc { /// The [acronym] parameter is required and must be a valid bloc acronym. /// {@macro any_code_object} /// Returns a [RegionalBloc] object that represents the bloc with the given - /// code or throws a [StateError] if no such bloc exists. + /// code if no such bloc exists. /// /// The optional [blocs] parameter can be used to specify a list of /// [RegionalBloc] objects to search through.