Skip to content

mne.viz.plot_source_estimates docs incorrectly say colormap can be supplied as an ndarray #13189

Description

@caiw

Proposed documentation enhancement

The docs on the website include:

colormap : str | np.ndarray of float, shape(n_colors, 3 | 4)

  • Name of colormap to use or a custom look up table. If array, must be (n x 3) or (n x 4) array for with RGB or RGBA values between 0 and 255. The default (‘auto’) uses 'hot' for one-sided data and ‘mne’ for two-sided data.

But then in _process_clim there is a call to _validate_type(colormap, (str, Colormap), "colormap"), which throws an error if an ndarray is supplied.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions