Skip to content

Add parameter type (links) for mpl_toolkits #24860

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add parameter type (links) for mpl_toolkits #24860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions lib/mpl_toolkits/axes_grid1/anchored_artists.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def __init__(self, transform, size, label, loc,
size_vertical : float, default: 0
Vertical length of the size bar, given in coordinates of
*transform*.
color : str, default: 'black'
color : :doc:`color </tutorials/colors/colors>`, default: 'black'
Color for the size bar and label.
label_top : bool, default: False
If True, the label will be over the size bar.
Expand Down Expand Up @@ -328,7 +328,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
Border padding, in fraction of the font size.
frameon : bool, default: False
If True, draw a box around the arrows and labels.
color : str, default: 'white'
color : :doc:`color </tutorials/colors/colors>`, default: 'white'
Color for the arrows and labels.
alpha : float, default: 1
Alpha values of the arrows and labels
Expand Down
34 changes: 19 additions & 15 deletions lib/mpl_toolkits/mplot3d/axes3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1496,7 +1496,7 @@ def plot(self, xs, ys, *args, zdir='z', **kwargs):

def plot_surface(self, X, Y, Z, *, norm=None, vmin=None,
vmax=None, lightsource=None, **kwargs):
"""
r"""
Create a surface plot.

By default, it will be colored in shades of a solid color, but it also
Expand Down Expand Up @@ -1538,23 +1538,23 @@ def plot_surface(self, X, Y, Z, *, norm=None, vmin=None,
'classic' mode uses a default of ``rstride = cstride = 10`` instead
of the new default of ``rcount = ccount = 50``.

color : color-like
color : :doc:`color </tutorials/colors/colors>`
Color of the surface patches.

cmap : Colormap
cmap : `~matplotlib.colors.Colormap`
Colormap of the surface patches.

facecolors : array-like of colors.
facecolors : array-like of :doc:`color </tutorials/colors/colors>`\s.
Colors of each individual patch.

norm : Normalize
norm : `~matplotlib.colors.Normalize`
Normalization for the colormap.

vmin, vmax : float
Bounds for the normalization.

shade : bool, default: True
Whether to shade the facecolors. Shading is always disabled when
Whether to shade the *facecolors*. Shading is always disabled when
*cmap* is specified.

lightsource : `~matplotlib.colors.LightSource`
Expand Down Expand Up @@ -1837,11 +1837,11 @@ def plot_trisurf(self, *args, color=None, norm=None, vmin=None, vmax=None,
----------
X, Y, Z : array-like
Data values as 1D arrays.
color
color : :doc:`color </tutorials/colors/colors>`
Color of the surface patches.
cmap
cmap : `~matplotlib.colors.Colormap`
A colormap for the surface patches.
norm : Normalize
norm : `~matplotlib.colors.Normalize`
An instance of Normalize to map values to colors.
vmin, vmax : float, default: None
Minimum and maximum value to map.
Expand Down Expand Up @@ -2235,7 +2235,8 @@ def scatter(self, xs, ys, zs=0, zdir='z', s=20, c=None, depthshade=True,
The marker size in points**2. Either an array of the same length
as *xs* and *ys* or a single value to make all markers the same
size.
c : color, sequence, or sequence of colors, optional
c : :doc:`color </tutorials/colors/colors>`, sequence, or sequence of \
colors, optional
The marker color. Possible values:

- A single color format string.
Expand Down Expand Up @@ -2356,7 +2357,8 @@ def bar3d(self, x, y, z, dx, dy, dz, color=None,
dx, dy, dz : float or array-like
The width, depth, and height of the bars, respectively.

color : sequence of colors, optional
color : :doc:`color </tutorials/colors/colors>` or sequence of \
colors, optional
The color of the bars can be specified globally or
individually. This parameter can be:

Expand Down Expand Up @@ -2688,7 +2690,8 @@ def voxels(self, *args, facecolors=None, edgecolors=None, shade=True,
As indicated by the ``/`` in the function signature, these
arguments can only be passed positionally.

facecolors, edgecolors : array-like, optional
facecolors, edgecolors : :doc:`color </tutorials/colors/colors>` or \
array-like of colors, optional
The color to draw the faces and edges of the voxels. Can only be
passed as keyword arguments.
These parameters can be:
Expand All @@ -2703,7 +2706,7 @@ def voxels(self, *args, facecolors=None, edgecolors=None, shade=True,
along the last axis.

shade : bool, default: True
Whether to shade the facecolors.
Whether to shade the *facecolors*.

lightsource : `~matplotlib.colors.LightSource`
The lightsource to use when *shade* is True.
Expand Down Expand Up @@ -2906,7 +2909,7 @@ def errorbar(self, x, y, z, zerr=None, yerr=None, xerr=None, fmt='',
Use 'none' (case-insensitive) to plot errorbars without any data
markers.

ecolor : color, default: None
ecolor : :doc:`color </tutorials/colors/colors>`, default: None
The color of the errorbar lines. If None, use the color of the
line connecting the markers.

Expand Down Expand Up @@ -3230,7 +3233,8 @@ def stem(self, x, y, z, *, linefmt='C0-', markerfmt='C0o', basefmt='C3-',

linefmt : str, default: 'C0-'
A string defining the properties of the vertical lines. Usually,
this will be a color or a color and a linestyle:
this will be a :doc:`color </tutorials/colors/colors>` or a color \
and a linestyle:

========= =============
Character Line Style
Expand Down
2 changes: 1 addition & 1 deletion lib/mpl_toolkits/mplot3d/axis3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ def set_pane_color(self, color, alpha=None):

Parameters
----------
color : color
color : :doc:`color </tutorials/colors/colors>`
Color for axis pane.
alpha : float, optional
Alpha value for axis pane. If None, base it on *color*.
Expand Down