Skip to content

DOC: remove incorrect colorbar reference from contours_topomap docstring#13682

Open
deveshbervar wants to merge 3 commits into
mne-tools:mainfrom
deveshbervar:fix-plot-topomap-docstring
Open

DOC: remove incorrect colorbar reference from contours_topomap docstring#13682
deveshbervar wants to merge 3 commits into
mne-tools:mainfrom
deveshbervar:fix-plot-topomap-docstring

Conversation

@deveshbervar

Copy link
Copy Markdown

Fixes #12698

What was changed

Removed the incorrect reference to the non-existent colorbar argument
from the contours parameter description in mne.viz.plot_topomap().

Why this change

The docstring mentioned colorbar=True, but plot_topomap() does not
have a colorbar argument. This PR updates the documentation to remove
the incorrect reference.

Implementation

  • Updated docdict["contours_topomap"] in mne/utils/docs.py
  • Removed the sentence referring to colorbar=True

@deveshbervar

Copy link
Copy Markdown
Author

Hi @cbrnr, I noticed the CI checks are blocked due to the block-unregistered-user restriction. Could you please approve the workflow so the checks can run? Thanks!

@cbrnr

cbrnr commented Feb 28, 2026

Copy link
Copy Markdown
Contributor

I don't know why I can't re-run the CircleCI jobs. @larsoner can you help? I'm logged in with my account but the options are still grayed out. Do you need to add me to an org?

@tsbinns

tsbinns commented Feb 28, 2026

Copy link
Copy Markdown
Contributor

@deveshbervar If you link your GitHub account to CircleCI and push a commit (even an empty one), the docs build will run without us needing to manually approve it.

Comment thread mne/utils/docs.py Outdated
@deveshbervar

Copy link
Copy Markdown
Author

Thanks! I’ve applied the suggested formatting fix.

@cbrnr cbrnr enabled auto-merge (squash) July 14, 2026 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docstring of mne.viz.plot_topomap() incorrect

3 participants