DOC: remove incorrect colorbar reference from contours_topomap docstring#13682
Open
deveshbervar wants to merge 2 commits intomne-tools:mainfrom
Open
DOC: remove incorrect colorbar reference from contours_topomap docstring#13682deveshbervar wants to merge 2 commits intomne-tools:mainfrom
deveshbervar wants to merge 2 commits intomne-tools:mainfrom
Conversation
Author
|
Hi @cbrnr, I noticed the CI checks are blocked due to the |
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? |
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. |
tsbinns
reviewed
Feb 28, 2026
mne/utils/docs.py
Outdated
| The values should be in µV for EEG, fT for magnetometers and fT/m for | ||
| gradiometers. If ``colorbar=True``, the colorbar will have ticks | ||
| corresponding to the contour levels. Default is ``6``. | ||
| gradiometers.Default is ``6``. |
Contributor
There was a problem hiding this comment.
Suggested change
| gradiometers.Default is ``6``. | |
| gradiometers. Default is ``6``. |
Should have a space.
Author
|
Thanks! I’ve applied the suggested formatting fix. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #12698
What was changed
Removed the incorrect reference to the non-existent
colorbarargumentfrom the
contoursparameter description inmne.viz.plot_topomap().Why this change
The docstring mentioned
colorbar=True, butplot_topomap()does nothave a
colorbarargument. This PR updates the documentation to removethe incorrect reference.
Implementation
docdict["contours_topomap"]inmne/utils/docs.pycolorbar=True