GMTDataArrayAccessor: Improve the documentation to clarify how the accessor works (#3955)

seisman · weiji14 · web-flow · commit 6396328eeeab · 2025-06-02T18:27:09.000+08:00
Co-authored-by: Wei Ji &lt;23487320+weiji14@users.noreply.github.com&gt;
diff --git a/pygmt/datasets/earth_age.py b/pygmt/datasets/earth_age.py
@@ -76,12 +76,8 @@ def load_earth_age(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_day.py b/pygmt/datasets/earth_day.py
@@ -72,12 +72,8 @@ def load_blue_marble(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` image can be accessed via the GMT accessors (i.e.,
-    ``image.gmt.registration`` and ``image.gmt.gtype`` respectively). However, these
-    properties may be lost after specific image operations (such as slicing) and will
-    need to be manually set before passing the image to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` image can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_deflection.py b/pygmt/datasets/earth_deflection.py
@@ -90,12 +90,8 @@ def load_earth_deflection(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_dist.py b/pygmt/datasets/earth_dist.py
@@ -77,12 +77,8 @@ def load_earth_dist(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_free_air_anomaly.py b/pygmt/datasets/earth_free_air_anomaly.py
@@ -90,12 +90,8 @@ def load_earth_free_air_anomaly(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_geoid.py b/pygmt/datasets/earth_geoid.py
@@ -70,13 +70,8 @@ def load_earth_geoid(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors
-    (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
-    However, these properties may be lost after specific grid operations (such
-    as slicing) and will need to be manually set before passing the grid to any
-    PyGMT data processing or plotting functions. Refer to
-    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
-    workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_magnetic_anomaly.py b/pygmt/datasets/earth_magnetic_anomaly.py
@@ -102,13 +102,8 @@ def load_earth_magnetic_anomaly(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors
-    (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
-    However, these properties may be lost after specific grid operations (such
-    as slicing) and will need to be manually set before passing the grid to any
-    PyGMT data processing or plotting functions. Refer to
-    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
-    workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_mask.py b/pygmt/datasets/earth_mask.py
@@ -89,13 +89,8 @@ def load_earth_mask(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors
-    (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
-    However, these properties may be lost after specific grid operations (such
-    as slicing) and will need to be manually set before passing the grid to any
-    PyGMT data processing or plotting functions. Refer to
-    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
-    workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_mean_dynamic_topography.py b/pygmt/datasets/earth_mean_dynamic_topography.py
@@ -73,12 +73,8 @@ def load_earth_mean_dynamic_topography(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_mean_sea_surface.py b/pygmt/datasets/earth_mean_sea_surface.py
@@ -76,12 +76,8 @@ def load_earth_mean_sea_surface(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_night.py b/pygmt/datasets/earth_night.py
@@ -71,12 +71,8 @@ def load_black_marble(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` image can be accessed via the GMT accessors (i.e.,
-    ``image.gmt.registration`` and ``image.gmt.gtype`` respectively). However, these
-    properties may be lost after specific image operations (such as slicing) and will
-    need to be manually set before passing the image to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` image can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_relief.py b/pygmt/datasets/earth_relief.py
@@ -118,13 +118,8 @@ def load_earth_relief(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors
-    (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
-    However, these properties may be lost after specific grid operations (such
-    as slicing) and will need to be manually set before passing the grid to any
-    PyGMT data processing or plotting functions. Refer to
-    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
-    workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/earth_vertical_gravity_gradient.py b/pygmt/datasets/earth_vertical_gravity_gradient.py
@@ -78,13 +78,8 @@ def load_earth_vertical_gravity_gradient(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors
-    (i.e., ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively).
-    However, these properties may be lost after specific grid operations (such
-    as slicing) and will need to be manually set before passing the grid to any
-    PyGMT data processing or plotting functions. Refer to
-    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and
-    workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/mars_relief.py b/pygmt/datasets/mars_relief.py
@@ -92,12 +92,8 @@ def load_mars_relief(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/mercury_relief.py b/pygmt/datasets/mercury_relief.py
@@ -91,12 +91,8 @@ def load_mercury_relief(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/moon_relief.py b/pygmt/datasets/moon_relief.py
@@ -92,12 +92,8 @@ def load_moon_relief(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/pluto_relief.py b/pygmt/datasets/pluto_relief.py
@@ -91,12 +91,8 @@ def load_pluto_relief(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/datasets/venus_relief.py b/pygmt/datasets/venus_relief.py
@@ -76,12 +76,8 @@ def load_venus_relief(
     Note
     ----
     The registration and coordinate system type of the returned
-    :class:`xarray.DataArray` grid can be accessed via the GMT accessors (i.e.,
-    ``grid.gmt.registration`` and ``grid.gmt.gtype`` respectively). However, these
-    properties may be lost after specific grid operations (such as slicing) and will
-    need to be manually set before passing the grid to any PyGMT data processing or
-    plotting functions. Refer to :class:`pygmt.GMTDataArrayAccessor` for detailed
-    explanations and workarounds.
+    :class:`xarray.DataArray` grid can be accessed via the *gmt* accessor. Refer to
+    :class:`pygmt.GMTDataArrayAccessor` for detailed explanations and limitations.
 
     Examples
     --------
diff --git a/pygmt/xarray/accessor.py b/pygmt/xarray/accessor.py
