diff --git a/docs/conf.py b/docs/conf.py index d1aac79..05fa4bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -79,6 +79,7 @@ def __getattr__(cls, name): "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), "numpy": ("https://numpy.org/doc/stable/", None), "monetio": ("https://monetio.readthedocs.io/en/stable/", None), + "matplotlib": ("https://matplotlib.org/stable/", None), } diff --git a/monet/monet_accessor.py b/monet/monet_accessor.py index 9965b2b..47b260e 100644 --- a/monet/monet_accessor.py +++ b/monet/monet_accessor.py @@ -960,10 +960,9 @@ def _check_kwargs_and_set_defaults(**kwargs): return kwargs def quick_imshow(self, map_kws=None, roll_dateline=False, **kwargs): - """This function takes an xarray DataArray and quickly creates a figure - using cartopy and matplotlib ``imshow``. + """Quickly create a geo-referenced image plot using Cartopy and Matplotlib. - Note that this should only be used for regular grids. + Note that this should only be used for regular grids (e.g. rectangular lat/lon grid). Parameters ---------- @@ -1028,8 +1027,7 @@ def quick_imshow(self, map_kws=None, roll_dateline=False, **kwargs): return ax def quick_map(self, map_kws=None, roll_dateline=False, **kwargs): - """This function takes an xarray DataArray and quickly creates a figure - using cartopy and matplotlib ``pcolormesh``. + """Quickly create a geo-referenced plot using Cartopy and Matplotlib. Parameters ---------- @@ -1041,6 +1039,7 @@ def quick_map(self, map_kws=None, roll_dateline=False, **kwargs): at 0 degrees. **kwargs : kwargs for :meth:`xarray.DataArray.plot.pcolormesh` + (actually passed to :meth:`xarray.DataArray.plot`, but pcolormesh is the usual result) Returns ------- @@ -1087,8 +1086,7 @@ def quick_map(self, map_kws=None, roll_dateline=False, **kwargs): return ax def quick_contourf(self, map_kws=None, roll_dateline=False, **kwargs): - """This function takes an xarray DataArray and quickly creates a figure - using cartopy and matplotlib ``contourf``. + """Quickly create a geo-referenced filled-contour plot using Cartopy and Matplotlib. Parameters ---------- diff --git a/monet/plots/mapgen.py b/monet/plots/mapgen.py index 5655a0c..ddae0ba 100644 --- a/monet/plots/mapgen.py +++ b/monet/plots/mapgen.py @@ -44,7 +44,7 @@ def draw_map( extent : array-like Set the map extent with ``[lon_min,lon_max,lat_min,lat_max]``. figsize : tuple - Figure size (width, height), passed to ``plt.subplots()``. + Figure size (width, height), passed to :func:`plt.subplots() `. This takes precedence over the possible ``kwargs['figsize']``. linewidth : float Line width for coastlines, states, counties, and countries. @@ -52,7 +52,7 @@ def draw_map( Return the figure and axes objects. By default (``False``), just the axes object is returned. **kwargs - Arguments pass to ``plt.subplots()``. + Arguments to pass to :func:`plt.subplots() `. Returns -------