Skip to content

Commit d862945

Browse files
authored
DOC: Remove invalid ndarray option from colormap docstrings (#13797)
1 parent 825eea3 commit d862945

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

doc/changes/dev/13797.other.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove :class:`numpy.ndarray` from ``colormap`` parameter in :func:`mne.viz.plot_source_estimates` to solve documentation conflict , by :newcontrib:`Lifeng Qiu Lin`.

doc/changes/names.inc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@
187187
.. _Leonardo Barbosa: https://github.com/noreun
188188
.. _Leonardo Rochael Almeida: https://github.com/leorochael
189189
.. _Liberty Hamilton: https://github.com/libertyh
190+
.. _Lifeng Qiu Lin: https://github.com/Gnefil
190191
.. _Lorenzo Desantis: https://github.com/lorenzo-desantis/
191192
.. _Lukas Breuer: https://www.researchgate.net/profile/Lukas-Breuer-2
192193
.. _Lukas Gemein: https://github.com/gemeinl

mne/utils/docs.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -835,10 +835,10 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
835835
"""
836836

837837
docdict["colormap"] = """
838-
colormap : str | np.ndarray of float, shape(n_colors, 3 | 4)
839-
Name of colormap to use or a custom look up table. If array, must
840-
be (n x 3) or (n x 4) array for with RGB or RGBA values between
841-
0 and 255.
838+
colormap : str | matplotlib.colors.Colormap
839+
Name of colormap to use or a custom Matplotlib colormap instance. If passing
840+
a custom colormap, it must be an instance of :class:`matplotlib.colors.Colormap`
841+
(e.g., :class:`matplotlib.colors.ListedColormap`).
842842
"""
843843

844844
_combine_template = """

0 commit comments

Comments
 (0)