diff --git a/doc/changes/dev/13797.other.rst b/doc/changes/dev/13797.other.rst new file mode 100644 index 00000000000..6619072b1ef --- /dev/null +++ b/doc/changes/dev/13797.other.rst @@ -0,0 +1 @@ +Remove :class:`numpy.ndarray` from ``colormap`` parameter in :func:`mne.viz.plot_source_estimates` to solve documentation conflict , by :newcontrib:`Lifeng Qiu Lin`. \ No newline at end of file diff --git a/doc/changes/names.inc b/doc/changes/names.inc index 48c3b86d2be..c42139ff57d 100644 --- a/doc/changes/names.inc +++ b/doc/changes/names.inc @@ -186,6 +186,7 @@ .. _Leonardo Barbosa: https://github.com/noreun .. _Leonardo Rochael Almeida: https://github.com/leorochael .. _Liberty Hamilton: https://github.com/libertyh +.. _Lifeng Qiu Lin: https://github.com/Gnefil .. _Lorenzo Desantis: https://github.com/lorenzo-desantis/ .. _Lukas Breuer: https://www.researchgate.net/profile/Lukas-Breuer-2 .. _Lukas Gemein: https://github.com/gemeinl diff --git a/mne/utils/docs.py b/mne/utils/docs.py index fc7d33a6f4b..ca586068a5d 100644 --- a/mne/utils/docs.py +++ b/mne/utils/docs.py @@ -835,10 +835,10 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75): """ docdict["colormap"] = """ -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. +colormap : str | matplotlib.colors.Colormap + Name of colormap to use or a custom Matplotlib colormap instance. If passing + a custom colormap, it must be an instance of :class:`matplotlib.colors.Colormap` + (e.g., :class:`matplotlib.colors.ListedColormap`). """ _combine_template = """