MRG: Fix docstring for plot_ica_components() #9826
Merged
Conversation
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
The `picks` section was 90% incorrect.
agramfort
approved these changes
Oct 9, 2021
hoechenberger
changed the title
hoechenberger
commented
Oct 9, 2021
Member
|
thx @hoechenberger |
larsoner
reviewed
Oct 11, 2021
Comment on lines
+1164
to
+1167
| fig : instance of matplotlib.figure.Figure | | ||
| list of matplotlib.figure.Figure | ||
|
|
||
| The figure object(s). Components are plotted on a grid with maximum |
Member
There was a problem hiding this comment.
This did not render properly:
https://35593-1301584-gh.circle-artifacts.com/0/dev/generated/mne.viz.plot_ica_components.html
The typical way to solve this problem is keep everything one one line, then add # noqa E501 after the closing """ of the docstring
Member
Author
There was a problem hiding this comment.
I will look into this, I thought this rendered okay previously. If there's indeed a problem, I may need to revise some of my Report docstrings too. Thaks for catching this, I'll take a look at this tonight.
larsoner
added a commit
to rob-luke/mne-python
that referenced
this pull request
Oct 11, 2021
* upstream/main: MAINT: Update broken link, fix rendering (mne-tools#9829) Ensure plot_ica_sources() always plots traces of rejected ICs on top (mne-tools#9823) Improve plot_ica_sources() docstring (mne-tools#9825) MRG: Fix docstring for plot_ica_components() (mne-tools#9826) unpin jsonschema and filter its warning instead (mne-tools#9822) Add warning for SNIRF files with != 2 wavelengths (mne-tools#9817) add show_scalebars param to epochs.plot() (mne-tools#9815) MRG: Allow _plot_mri_contours() to return arrays (mne-tools#9818) MRG: Expand ~ in _check_fname() (mne-tools#9613) Improve ICA.plot_overlay() docstrings (mne-tools#9820) WIP, MAINT: Fix CircleCI (again) (mne-tools#9814) MRG, ENH: Add options to fit_dipole (mne-tools#9810) Rework Reports (new history) (mne-tools#9754) MRG, CI: Use VTK pre (mne-tools#9803)
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.
The
pickssection was 90% incorrect.