fix

Author: seisman

doc/_templates/autosummary/class.rst

@@ -17,6 +17,7 @@
 .. rubric:: Methods Summary
 
 .. autosummary::
+    :toctree:
     {% for item in methods %}
     {% if item != '__init__' %}
     {{ objname }}.{{ item }}

doc/api/index.rst

@@ -221,6 +221,7 @@ Miscellaneous
 
     which
     show_versions
+    pygmt.src.clip.ClipAccessor
 
 Datasets
 --------

pygmt/figure.py

@@ -8,7 +8,7 @@
 from tempfile import TemporaryDirectory
 from typing import Literal, overload
 
-from pygmt.src import clip
+from pygmt.src.clip import ClipAccessor
 from pygmt._typing import PathLike
 
 try:
@@ -139,15 +139,13 @@ def region(self) -> np.ndarray:
         return wesn
 
     @property
-    def clip(self) -> clip:
+    def clip(self) -> ClipAccessor:
         """
         Set up a clipping path.
 
-        - :meth:`pygmt.Figure.clip.land`
-        - :meth:`pygmt.Figure.clip.water`
-        - :meth:`pygmt.Figure.clip.polygon`
+        :class:`pygmt.src.clip.ClipAccessor`
         """
-        return clip()
+        return ClipAccessor()
 
     def savefig(
         self,

pygmt/src/__init__.py

@@ -5,7 +5,6 @@
 from pygmt.src.basemap import basemap
 from pygmt.src.binstats import binstats
 from pygmt.src.blockm import blockmean, blockmedian, blockmode
-from pygmt.src.clip import clip
 from pygmt.src.coast import coast
 from pygmt.src.colorbar import colorbar
 from pygmt.src.config import config

pygmt/src/clip.py

@@ -19,7 +19,7 @@ def _clip_method(clip_type):
             return "coast"
 
 
-class clip:  # noqa: N801
+class ClipAccessor:
     """
     Clip.
     """
@@ -33,6 +33,11 @@ def __init__(self):
     def polygon(self, x, y):
         """
         Clip the data to a polygon.
+
+        Parameters
+        ----------
+        x/y
+            Coordinates of polygon.
         """
         self.type = "polygon"
         self.data = (x, y)