update strings and func name

Author: NicolasColombi

climada/entity/impact_funcs/test/test_tc.py

@@ -169,39 +169,41 @@ def test_get_countries_per_region(self):
         self.assertListEqual(out[3], ["CAN", "USA"])
 
     def test_get_region_per_countries(self):
-        """Test static get_regions_per_countries()"""
+        """Test get_impf_id_regions_per_countries()"""
         ifs = ImpfSetTropCyclone()
-        out = ifs.get_regions_per_countries(countries=["CHE"], code_type="ISO3A")
+        out = ifs.get_impf_id_regions_per_countries(
+            countries=["CHE"], code_type="ISO3A"
+        )
         self.assertEqual(out[0][0], 10)
         self.assertEqual(out[1][0], "ROW")
         self.assertEqual(out[2][0], "Rest of The World")
-        out = ifs.get_regions_per_countries(countries=[756], code_type="ISO3N")
+        out = ifs.get_impf_id_regions_per_countries(countries=[756], code_type="ISO3N")
         self.assertEqual(out[0][0], 10)
         self.assertEqual(out[1][0], "ROW")
         self.assertEqual(out[2][0], "Rest of The World")
         with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_regions_per_countries(
+            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
                 countries=["SWE"], code_type="invalid_code"
             )
         self.assertEqual(
             str(context.exception), "code_type must be either 'iso3a' or 'iso3n'"
         )
         with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_regions_per_countries(
+            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
                 countries=["SWE", 840], code_type="ISO3A"
             )
         self.assertEqual(
             str(context.exception), "All elements in the list must be of the same type."
         )
         with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_regions_per_countries(
+            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
                 countries=[840, 124], code_type="ISO3A"
             )
         self.assertEqual(
             str(context.exception), "ISO3A code type cannot have integer values."
         )
         with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_regions_per_countries(
+            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
                 countries=["MEX"], code_type="ISO3N"
             )
         self.assertEqual(

climada/entity/impact_funcs/trop_cyclone.py

@@ -50,7 +50,7 @@ class CountryCode(Enum):
             A mapping of region names to corresponding impact function IDs.
         REGION_NAME: dict
             A mapping of region names to their descriptive names.
-      """"
+    """
 
     # fmt: off
     ISO3N = {
@@ -458,7 +458,7 @@ def get_countries_per_region(region=None):
         )
 
     @staticmethod
-    def get_regions_per_countries(
+    def get_impf_id_regions_per_countries(
         countries: list = None, code_type: str = "ISO3A"
     ) -> tuple:
         """Return the impact function id and the region corresponding to a list of countries,
@@ -467,20 +467,24 @@ def get_regions_per_countries(
         Parameters:
         -----------
         countries : list
-            List containing the ISO code of the country, which should be either
-            a string if the code is iso3a or an integer if ISO3N. For example, for Switzerland:
-            the ISO3A code is "CHE" and the ISO3N is 756.
+            List containing the ISO codes of the country, which should be either
+            in string format if the code is "ISO3A" or an integer if "ISO3N", see code_type below.
         code_type : str
-            Either "ISO3A" or "ISO3N".
+            Either "ISO3A" or "ISO3N". "ISO3A" stands for "ISO 3166-1 alpha-3" which is a
+            three-letter country code, "ISO3N" stands for "ISO 3166-1 numeric" which is a
+            three-digit country code, the numeric version of "ISO3A". For example, for Switzerland:
+            the "ISO3A" code is "CHE" and the "ISO3N" is 756.
 
         Returns:
         --------
         impf_ids : list
             List of impact function ids matching the countries.
         regions_ids : list
-            List of the regions that match the countries.
+            List of the region ids. Regions are a container of countries as defined in:
+            https://nhess.copernicus.org/articles/21/393/2021/nhess-21-393-2021.pdf, and implemented
+            in the CountryCode Enum Class. Example: "NA1", "NA2", ...
         regions_names : list
-            List of the regions that match the countries.
+            List of the regions names. Example: "Caribbean and Mexico", "USA and Canada", ...
         """
 
         if code_type not in {"ISO3A", "ISO3N"}: