Skip to content

Commit c1272b5

Browse files
cspencerjonesSpencer Jones
and
Spencer Jones
authored
Tweaked Dataset.plot docs to better describe quiver (#5100)
Co-authored-by: Spencer Jones <[email protected]>
1 parent 1736e8f commit c1272b5

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

xarray/plot/dataset_plot.py

+10-7
Original file line numberDiff line numberDiff line change
@@ -198,15 +198,19 @@ def _dsplot(plotfunc):
198198
x, y : str
199199
Variable names for x, y axis.
200200
u, v : str, optional
201-
Variable names for quiver or streamplot plots
201+
Variable names for quiver or streamplot plots only
202202
hue: str, optional
203-
Variable by which to color scattered points
203+
Variable by which to color scattered points or arrows
204204
hue_style: str, optional
205205
Can be either 'discrete' (legend) or 'continuous' (color bar).
206206
markersize: str, optional
207207
scatter only. Variable by which to vary size of scattered points.
208208
size_norm: optional
209209
Either None or 'Norm' instance to normalize the 'markersize' variable.
210+
scale: scalar, optional
211+
Quiver only. Number of data units per arrow length unit.
212+
Use this to control the length of the arrows: larger values lead to
213+
smaller arrows
210214
add_guide: bool, optional
211215
Add a guide that depends on hue_style
212216
- for "discrete", build a legend.
@@ -245,12 +249,11 @@ def _dsplot(plotfunc):
245249
be either ``viridis`` (if the function infers a sequential
246250
dataset) or ``RdBu_r`` (if the function infers a diverging
247251
dataset). When `Seaborn` is installed, ``cmap`` may also be a
248-
`seaborn` color palette. If ``cmap`` is seaborn color palette
249-
and the plot type is not ``contour`` or ``contourf``, ``levels``
250-
must also be specified.
252+
`seaborn` color palette. If ``cmap`` is seaborn color palette,
253+
``levels`` must also be specified.
251254
colors : color-like or list of color-like, optional
252-
A single color or a list of colors. If the plot type is not ``contour``
253-
or ``contourf``, the ``levels`` argument is required.
255+
A single color or a list of colors. The ``levels`` argument
256+
is required.
254257
center : float, optional
255258
The value at which to center the colormap. Passing this value implies
256259
use of a diverging colormap. Setting it to ``False`` prevents use of a

0 commit comments

Comments
 (0)