Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Doc]: Document color in a consistent way, including link #24859

Copy link
Copy link
Closed
@oscargus

Description

@oscargus
Issue body actions

Documentation Link

No response

Problem

Matplotlib has a rather flexible color concept, see https://matplotlib.org/stable/tutorials/colors/colors.html

In the documentation, the type of color arguments is often, but not always, listed as "color", although there are limited hints what this actually means.

Suggested improvement

Link the type color to the page above (is there a better one?). Update other types (like str) to be color.

:doc:`color </tutorials/colors/colors>`

These are the ones I found through a simple grep.

matplotlib/axes/_axes.py:        facecolor : color, default: 'none'
matplotlib/axes/_axes.py:        edgecolor : color, default: '0.5'
matplotlib/axes/_axes.py:        color : color or list of color, optional
matplotlib/axes/_axes.py:        edgecolor : color or list of color, optional
matplotlib/axes/_axes.py:        ecolor : color or list of color, default: 'black'
matplotlib/axes/_axes.py:        color : color or list of color, optional
matplotlib/axes/_axes.py:        edgecolor : color or list of color, optional
matplotlib/axes/_axes.py:        ecolor : color or list of color, default: 'black'
matplotlib/axes/_axes.py:        ecolor : color, default: None
matplotlib/axes/_axes.py:        pcolor : An alternative implementation with slightly different
matplotlib/axes/_axes.py:        color : color or array-like of colors or None, default: None
matplotlib/axes/_base.py:        color : color
matplotlib/axes/_base.py:        color : color
matplotlib/axes/_base.py:        labelcolor : color
matplotlib/axes/_base.py:        grid_color : color
matplotlib/axes/_secondary_axes.py:        color : color
matplotlib/backend_bases.py:        facecolor : color or 'auto', default: :rc:`savefig.facecolor`
matplotlib/backend_bases.py:        edgecolor : color or 'auto', default: :rc:`savefig.edgecolor`
matplotlib/collections.py:        color : color or list of colors, default: :rc:`lines.color`
matplotlib/figure.py:        color : color
matplotlib/figure.py:        color : color
matplotlib/figure.py:        facecolor : default: :rc:`figure.facecolor`
matplotlib/figure.py:        edgecolor : default: :rc:`figure.edgecolor`
matplotlib/figure.py:        facecolor : default: :rc:`figure.facecolor`
matplotlib/figure.py:        edgecolor : default: :rc:`figure.edgecolor`
matplotlib/figure.py:        facecolor : color or 'auto', default: :rc:`savefig.facecolor`
matplotlib/figure.py:        edgecolor : color or 'auto', default: :rc:`savefig.edgecolor`
matplotlib/legend.py:labelcolor : str or list, default: :rc:`legend.labelcolor`
matplotlib/legend.py:facecolor : "inherit" or color, default: :rc:`legend.facecolor`
matplotlib/legend.py:edgecolor : "inherit" or color, default: :rc:`legend.edgecolor`
matplotlib/lines.py:        color : color
matplotlib/lines.py:        gapcolor : color or None
matplotlib/mathtext.py:    color : str, optional
matplotlib/patches.py:        color : color or None
matplotlib/patches.py:        color : color or None
matplotlib/patheffects.py:        shadow_color : color, default: 'black'
matplotlib/pyplot.py:    facecolor : color, default: :rc:`figure.facecolor`
matplotlib/pyplot.py:    edgecolor : color, default: :rc:`figure.edgecolor`
matplotlib/quiver.py:color : color or color sequence, optional
matplotlib/quiver.py:        color : color
matplotlib/quiver.py:        labelcolor : color, default: :rc:`text.color`
matplotlib/quiver.py:barbcolor : color or color sequence
matplotlib/quiver.py:flagcolor : color or color sequence
matplotlib/streamplot.py:    color : color or 2D array
matplotlib/table.py:        edgecolor : color
matplotlib/table.py:        facecolor : color
matplotlib/text.py:        color : color
matplotlib/text.py:        color : color
matplotlib/widgets.py:        color : color
matplotlib/widgets.py:        hovercolor : color
matplotlib/widgets.py:        initcolor : color, default: 'r'
matplotlib/widgets.py:        track_color : color, default: 'lightgrey'
matplotlib/widgets.py:        track_color : color, default: 'lightgrey'
matplotlib/widgets.py:    color : color
matplotlib/widgets.py:    hovercolor : color
matplotlib/widgets.py:        color : color
matplotlib/widgets.py:        hovercolor : color
matplotlib/widgets.py:    activecolor : color
matplotlib/widgets.py:        activecolor : color
mpl_toolkits/axes_grid1/anchored_artists.py:        color : str, default: 'black'
mpl_toolkits/axes_grid1/anchored_artists.py:        color : str, default: 'white'
mpl_toolkits/mplot3d/axes3d.py:        color : color-like
mpl_toolkits/mplot3d/axes3d.py:        color : sequence of colors, optional
mpl_toolkits/mplot3d/axes3d.py:        ecolor : color, default: None
mpl_toolkits/mplot3d/axis3d.py:        color : color
matplotlib/axes/_axes.py:        colors : list of colors, default: :rc:`lines.color`
matplotlib/axes/_axes.py:        colors : list of colors, default: :rc:`lines.color`
matplotlib/axes/_axes.py:        colors : color or list of colors, default: :rc:`lines.color`
matplotlib/axes/_axes.py:        colors : array-like, default: None
matplotlib/axes/_axes.py:        edgecolors : color or sequence of color or {'face', 'none'} or None
matplotlib/axes/_axes.py:        colors : array(N, 4) or None
matplotlib/axes/_axes.py:        edgecolors : {'face', 'none', *None*} or color or sequence of color, \
matplotlib/axes/_axes.py:        edgecolors : {'face', 'none', *None*} or color, default: 'face'
matplotlib/axes/_axes.py:        edgecolors : {'none', None, 'face', color, color sequence}, optional
matplotlib/axes/_axes.py:        edgecolors : {'none', None, 'face', color, color sequence}, optional
matplotlib/axes/_base.py:        colors : color
matplotlib/backend_bases.py:        colors : (3, 4) array-like
matplotlib/backend_bases.py:        colors : (N, 3, 4) array-like
matplotlib/backends/backend_pdf.py:        colors : np.ndarray
matplotlib/collections.py:        edgecolors : color or list of colors, default: :rc:`patch.edgecolor`
matplotlib/collections.py:        facecolors : color or list of colors, default: :rc:`patch.facecolor`
matplotlib/collections.py:        colors : color or list of color, default: :rc:`lines.color`
matplotlib/collections.py:        facecolors : color or list of color, default: 'none'
matplotlib/colorbar.py:        colors : color or list of colors
matplotlib/colors.py:        colors : array-like of colors or array-like of (value, color)
matplotlib/colors.py:    colors : list, array
matplotlib/colors.py:    colors : sequence of colors
matplotlib/contour.py:        colors : color or colors or None, default: None
matplotlib/contour.py:colors : color string or sequence of colors, optional
matplotlib/stackplot.py:    colors : list of color, optional
matplotlib/tri/_tricontour.py:colors : color string or sequence of colors, optional
matplotlib/tri/_tripcolor.py:    facecolors : array-like, optional
mpl_toolkits/mplot3d/axes3d.py:        facecolors : array-like of colors.
mpl_toolkits/mplot3d/axes3d.py:        facecolors, edgecolors : array-like, optional
matplotlib/axes/_axes.py:        c : color or sequence or sequence of color or None
matplotlib/backend_bases.py:        fg : color
matplotlib/collections.py:        c : color or list of RGBA tuples
matplotlib/collections.py:        c : color or list of colors
matplotlib/collections.py:        c : color or list of colors or 'face'
matplotlib/collections.py:        c : color or list of colors
matplotlib/lines.py:        ec : color
matplotlib/lines.py:        fc : color
matplotlib/lines.py:        fc : color
matplotlib/patches.py:        c : color
matplotlib/patheffects.py:        shadow_rgbFace : color
matplotlib/spines.py:        c : color
mpl_toolkits/mplot3d/axes3d.py:        c : color, sequence, or sequence of colors, optional

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.