Improve docs for raw.to_data_frame #13590
Open
+5
−0
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
1himan
requested review from
agramfort,
dengemann,
drammock and
mscheltienne
as code owners
Author
|
Do I have to describe the changes in the changelog as well, for such a minor change? |
Contributor
|
I would argue the unit conversion behaviour is already described in the Also, the note has it the wrong way around: data is stored internally in standard (SI) units (e.g., V for EEG data), but what the method returns is the data scaled into a more appropriate range (e.g., uV for EEG data). |
drammock
reviewed
Jan 14, 2026
Comment on lines
+2458
to
+2459
| This method by default converts the data(:class:`pandas.DataFrame`) to its | ||
| standard unit and then returns it. See :ref:`units` and :term:`data channels`. |
Member
There was a problem hiding this comment.
this is inaccurate. Please read the param description for scalings in this method's docstring
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.
Reference issue (if any)
Fixes #12701
What does this implement/fix?
Additional information
Just a minor improvement for more clarity in the documentation.
An added notes section under raw.to_data_frame(), explicitly explaining the default behaviour of that api, which is to convert the data to SI units before returning it by default.