Skip to content

DOC: Remove invalid ndarray option from colormap docstrings #13797

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

Open
Gnefil wants to merge 3 commits into
base: main
Choose a base branch
from
+6 −4
Open

DOC: Remove invalid ndarray option from colormap docstrings #13797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3a6e3a
DOC: Remove invalid ndarray option from colormap docstrings
Gnefil Mar 29, 2026
b6939da
DOC: Add changelog for #13797
Gnefil Mar 29, 2026
a2438c7
DOC: Update to clearer explanation and apply backticks correctly
Gnefil Mar 30, 2026
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
1 change: 1 addition & 0 deletions doc/changes/dev/13797.other.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.
1 change: 1 addition & 0 deletions doc/changes/names.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions mne/utils/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = """
Expand Down
Loading