Skip to content

Commit e39a852

Browse files
authored
improve docstring for plot_3d_grid
1 parent ef7072d commit e39a852

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

pyxlma/plot/xlma_plot_feature.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,13 @@ def plot_3d_grid(bk_plot, xedges, yedges, zedges, tedges,
111111
"""
112112
Plot gridded fields on an existing bk_plot given x,y,z,t grids and
113113
respective grid edges
114+
115+
In previous versions, 'plot_cmap' was required positional argument, this now defaults to None/matplotlib default unless overridden
116+
Before the addition of **kwargs, 'vmin' was hardcoded to 0. This allows the user to specify a vmin in **kwargs, but maintain
117+
backwards compatibility with assuming a vmin of 0 if no vmin is provided
118+
114119
"""
120+
115121
plot_cmap = kwargs.pop('cmap', kwargs.pop('plot_cmap', None))
116122
plot_vmin = kwargs.pop('vmin', 0)
117123

0 commit comments

Comments
 (0)