DOC: Fix type annotation for order parameter in Epochs.plot() #13639
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
scott-huberty
approved these changes
Feb 6, 2026
Contributor
scott-huberty
left a comment
scott-huberty
left a comment
There was a problem hiding this comment.
Just a couple nitpicks. Otherwise this looks correct and matches the docstring for the order parameter in raw.plot!
| Defaults to ``None``. | ||
| order : array of str | None | ||
| Order in which to plot channel types. | ||
| order : array of int | None |
Contributor
There was a problem hiding this comment.
Suggested change
| order : array of int | None | |
| order : array-like of int | None |
| Order in which to plot channel types. | ||
| order : array of int | None | ||
| Order in which to plot data. If the array is shorter than the number of | ||
| channels, only the given channels are plotted. If None (default), all |
Contributor
There was a problem hiding this comment.
Suggested change
| channels, only the given channels are plotted. If None (default), all | |
| channels, only the given channels are plotted. If ``None`` (default), all |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Reference issue
Fixes #13638
What does this implement/fix?
This PR corrects the documentation for the order parameter in the Epochs plotting function.
The docstring previously stated that the parameter accepted an "array of strings," but it actually requires an array of integers (channel indices). I have updated the type definition and expanded the description to be consistent with the other plotting functions in the library.
Additional information
Fixing this discrepancy ensures that users can rely on the documentation without needing trial-and-error to figure out the correct input type for channel ordering.