fix regridder loading docstring

stephenworsley · Sep 6, 2024 · 229bdfd · 229bdfd
1 parent 3aa967d
commit 229bdfd
Showing 1 changed file with 7 additions and 6 deletions.
diff --git a/esmf_regrid/experimental/io.py b/esmf_regrid/experimental/io.py
@@ -274,10 +274,12 @@ def load_regridder(filename):
     """
     Load a regridder scheme instance.
 
-    Loads either a
-    :class:`~esmf_regrid.experimental.unstructured_scheme.GridToMeshESMFRegridder`
-    or a
-    :class:`~esmf_regrid.experimental.unstructured_scheme.MeshToGridESMFRegridder`.
+    Loads any of the regridder classes, i.e.
+    :class:`~esmf_regrid.experimental.unstructured_scheme.GridToMeshESMFRegridder`,
+    :class:`~esmf_regrid.experimental.unstructured_scheme.MeshToGridESMFRegridder`,
+    :class:`~esmf_regrid.schemes.ESMFAreaWeightedRegridder`,
+    :class:`~esmf_regrid.schemes.ESMFBilinearRegridder` or
+    :class:`~esmf_regrid.schemes.ESMFNearestRegridder`.
 
     Parameters
     ----------
@@ -286,8 +288,7 @@ def load_regridder(filename):
 
     Returns
     -------
-    :class:`~esmf_regrid.experimental.unstructured_scheme.GridToMeshESMFRegridder` or :class:`~esmf_regrid.experimental.unstructured_scheme.MeshToGridESMFRegridder`
-    """
+    :class:`~esmf_regrid.schemes._ESMFRegridder`    """
     with _load_context():
         cubes = iris.load(filename)