Make arguments for 'direction' parameter readable

Author: yvonnefroehlich

pygmt/datasets/earth_deflection.py

@@ -20,10 +20,10 @@ def load_earth_deflection(
     ] = "01d",
     region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
-    direction: Literal["edefl", "ndefl"] = "edefl",
+    direction: Literal["east_west", "south_north"] = "east_west",
 ) -> xr.DataArray:
     r"""
-    Load the IGPP Earth east-west and south-north deflections datasets in various
+    Load the IGPP Earth east-west and south-north deflection datasets in various
     resolutions.
 
     .. list-table::
@@ -71,8 +71,8 @@ def load_earth_deflection(
         ``"gridline"`` for gridline registration. Default is ``None``, means
         ``"gridline"`` for all resolutions except ``"01m"`` which is ``"pixel"`` only.
     direction
-        By default, the east-west deflection (``direction="edefl"``) is returned, set
-        ``direction="ndefl"`` to return the south-north deflection.
+        By default, the east-west deflection (``direction="east_west"``) is returned,
+        ``direction="south_north"`` to return the south-north deflection.
 
     Returns
     -------
@@ -106,7 +106,7 @@ def load_earth_deflection(
     ...     resolution="05m", region=[120, 160, 30, 60], registration="gridline"
     ... )
     """
-    prefix = "earth_ndefl" if direction == "ndefl" else "earth_edefl"
+    prefix = "earth_ndefl" if direction == "south_north" else "earth_edefl"
     grid = _load_remote_dataset(
         name=prefix,
         prefix=prefix,

pygmt/tests/test_datasets_earth_deflection.py

@@ -59,7 +59,7 @@ def test_earth_ndefl_01d():
     """
     Test some properties of the Earth south-north deflection 01d data.
     """
-    data = load_earth_deflection(resolution="01d", direction="ndefl")
+    data = load_earth_deflection(resolution="01d", direction="south_north")
     assert data.name == "z"
     assert data.attrs["long_name"] == "ndefl (microradians)"
     assert data.attrs["description"] == "IGPP Earth south-north deflection"
@@ -78,7 +78,7 @@ def test_earth_ndefl_01d_with_region():
     Test loading low-resolution Earth south-north deflection with "region".
     """
     data = load_earth_deflection(
-        resolution="01d", region=[-10, 10, -5, 5], direction="ndefl"
+        resolution="01d", region=[-10, 10, -5, 5], direction="south_north"
     )
     assert data.shape == (11, 21)
     assert data.gmt.registration == 0
@@ -94,7 +94,7 @@ def test_earth_ndefl_01m_default_registration():
     registration.
     """
     data = load_earth_deflection(
-        resolution="01m", region=[-10, -9, 3, 5], direction="ndefl"
+        resolution="01m", region=[-10, -9, 3, 5], direction="south_north"
     )
     assert data.shape == (120, 60)
     assert data.gmt.registration == 1