Skip to content

Tweaked Dataset.plot docs to better describe quiver #5100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 1, 2021
Merged

Tweaked Dataset.plot docs to better describe quiver #5100

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0011d3e
tweaked docs to better describe quiver
Mar 31, 2021
685a10f
Ran pre-commit
Mar 31, 2021
73414f9
fixed minor indentation
Mar 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions xarray/plot/dataset_plot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,15 +198,19 @@ def _dsplot(plotfunc):
x, y : str
Variable names for x, y axis.
u, v : str, optional
Variable names for quiver or streamplot plots
Variable names for quiver or streamplot plots only
hue: str, optional
Variable by which to color scattered points
Variable by which to color scattered points or arrows
hue_style: str, optional
Can be either 'discrete' (legend) or 'continuous' (color bar).
markersize: str, optional
scatter only. Variable by which to vary size of scattered points.
size_norm: optional
Either None or 'Norm' instance to normalize the 'markersize' variable.
scale: scalar, optional
Quiver only. Number of data units per arrow length unit.
Use this to control the length of the arrows: larger values lead to
smaller arrows
add_guide: bool, optional
Add a guide that depends on hue_style
- for "discrete", build a legend.
Expand Down Expand Up @@ -245,12 +249,11 @@ def _dsplot(plotfunc):
be either ``viridis`` (if the function infers a sequential
dataset) or ``RdBu_r`` (if the function infers a diverging
dataset). When `Seaborn` is installed, ``cmap`` may also be a
`seaborn` color palette. If ``cmap`` is seaborn color palette
and the plot type is not ``contour`` or ``contourf``, ``levels``
must also be specified.
`seaborn` color palette. If ``cmap`` is seaborn color palette,
``levels`` must also be specified.
colors : color-like or list of color-like, optional
A single color or a list of colors. If the plot type is not ``contour``
or ``contourf``, the ``levels`` argument is required.
A single color or a list of colors. The ``levels`` argument
is required.
center : float, optional
The value at which to center the colormap. Passing this value implies
use of a diverging colormap. Setting it to ``False`` prevents use of a
Expand Down