From 6a921d7542c443fd9376d5b7f759733bdd2f9e0c Mon Sep 17 00:00:00 2001 From: Lars Buntemeyer Date: Sun, 2 Jul 2023 20:44:57 +0200 Subject: [PATCH] update api docs --- cordex/accessor.py | 12 +++++++++++- docs/api.rst | 1 + 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/cordex/accessor.py b/cordex/accessor.py index 951ec70..a58a42a 100644 --- 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 index f892c88..05fa2d8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -106,3 +106,4 @@ Methods Dataset.cx.info Dataset.cx.guess + Dataset.cx.map