region can be a string type

GenericMappingTools · May 27, 2024 · 9c2ac53 · 9c2ac53
1 parent 7369cba
commit 9c2ac53
Show file tree

Hide file tree

Showing 12 changed files with 35 additions and 35 deletions.
diff --git a/pygmt/datasets/earth_age.py b/pygmt/datasets/earth_age.py
@@ -17,7 +17,7 @@ def load_earth_age(
     resolution: Literal[
         "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m"
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel"] = "gridline",
 ):
     r"""
@@ -57,8 +57,8 @@ def load_earth_age(
         arc-minutes.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration.

diff --git a/pygmt/datasets/earth_free_air_anomaly.py b/pygmt/datasets/earth_free_air_anomaly.py
@@ -17,7 +17,7 @@ def load_earth_free_air_anomaly(
     resolution: Literal[
         "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m"
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
 ):
     r"""
@@ -57,8 +57,8 @@ def load_earth_free_air_anomaly(
         arc-minutes.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/earth_geoid.py b/pygmt/datasets/earth_geoid.py
@@ -17,7 +17,7 @@ def load_earth_geoid(
     resolution: Literal[
         "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m"
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel"] = "gridline",
 ):
     r"""
@@ -50,8 +50,8 @@ def load_earth_geoid(
         arc-minutes.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration.

diff --git a/pygmt/datasets/earth_magnetic_anomaly.py b/pygmt/datasets/earth_magnetic_anomaly.py
@@ -18,7 +18,7 @@ def load_earth_magnetic_anomaly(
     resolution: Literal[
         "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m"
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
     data_source: Literal["emag2", "emag2_4km", "wdmam"] = "emag2",
 ):
@@ -71,8 +71,8 @@ def load_earth_magnetic_anomaly(
         ``data_source="wdmam"``.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/earth_mask.py b/pygmt/datasets/earth_mask.py
@@ -29,7 +29,7 @@ def load_earth_mask(
         "30s",
         "15s",
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel"] = "gridline",
 ):
     r"""
@@ -62,7 +62,7 @@ def load_earth_mask(
         arc-minutes, and arc-seconds.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*].
+        *ymin*, *ymax*] or an ISO country code.
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration.

diff --git a/pygmt/datasets/earth_relief.py b/pygmt/datasets/earth_relief.py
@@ -32,7 +32,7 @@ def load_earth_relief(
         "03s",
         "01s",
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
     data_source: Literal["igpp", "gebco", "gebcosi", "synbath"] = "igpp",
     use_srtm: bool = False,
@@ -78,8 +78,8 @@ def load_earth_relief(
         arc-minutes, and arc-seconds.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/earth_vertical_gravity_gradient.py b/pygmt/datasets/earth_vertical_gravity_gradient.py
@@ -17,7 +17,7 @@ def load_earth_vertical_gravity_gradient(
     resolution: Literal[
         "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m"
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
 ):
     r"""
@@ -57,8 +57,8 @@ def load_earth_vertical_gravity_gradient(
         arc-minutes.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/mars_relief.py b/pygmt/datasets/mars_relief.py
@@ -30,7 +30,7 @@ def load_mars_relief(
         "15s",
         "12s",
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
 ):
     r"""
@@ -69,8 +69,8 @@ def load_mars_relief(
         arc-minutes and arc-seconds.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/mercury_relief.py b/pygmt/datasets/mercury_relief.py
@@ -28,7 +28,7 @@ def load_mercury_relief(
         "01m",
         "56s",
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
 ):
     r"""
@@ -67,8 +67,8 @@ def load_mercury_relief(
         arc-minutes and arc-seconds.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/moon_relief.py b/pygmt/datasets/moon_relief.py
@@ -30,7 +30,7 @@ def load_moon_relief(
         "15s",
         "14s",
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
 ):
     r"""
@@ -69,8 +69,8 @@ def load_moon_relief(
         arc-minutes and arc-seconds.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/pluto_relief.py b/pygmt/datasets/pluto_relief.py
@@ -28,7 +28,7 @@ def load_pluto_relief(
         "01m",
         "52s",
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
 ):
     r"""
@@ -67,8 +67,8 @@ def load_pluto_relief(
         arc-minutes and arc-seconds.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, means

diff --git a/pygmt/datasets/venus_relief.py b/pygmt/datasets/venus_relief.py
@@ -17,7 +17,7 @@ def load_venus_relief(
     resolution: Literal[
         "01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m"
     ] = "01d",
-    region: Sequence[float] | None = None,
+    region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel"] = "gridline",
 ):
     r"""
@@ -56,8 +56,8 @@ def load_venus_relief(
         arc-minutes.
     region
         The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
-        *ymin*, *ymax*]. Required for grids with resolutions higher than 5 arc-minutes
-        (i.e., ``"05m"``).
+        *ymin*, *ymax*] or an ISO country code. Required for grids with resolutions
+        higher than 5 arc-minutes (i.e., ``"05m"``).
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration.