update api docs

euro-cordex · Jul 2, 2023 · 6a921d7 · 6a921d7
1 parent 0356b1f
commit 6a921d7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/cordex/accessor.py b/cordex/accessor.py
@@ -74,7 +74,17 @@ def guess(self):
         return self._guess
 
     def map(self, projection=None):
-        """ """
+        """Create a simple overview map.
+
+        Creates a simple map overview. By default, the map projection
+        defaults to the grid mapping attribute.
+
+        Returns
+        -------
+        ax : GeoAxesSubplot
+            Cartopy plot projection using tiles.
+
+        """
         import cartopy.crs as ccrs
         import cartopy.feature as cf
         import cartopy.io.img_tiles as cimgt

diff --git a/docs/api.rst b/docs/api.rst
@@ -106,3 +106,4 @@ Methods
 
     Dataset.cx.info
     Dataset.cx.guess
+    Dataset.cx.map