DOC: clarify add_reference_channels usage (Takeover #13664)#13846
DOC: clarify add_reference_channels usage (Takeover #13664)#13846Dpereaptkhamur-13 wants to merge 8 commits intomne-tools:mainfrom
Conversation
|
Hey @Dpereaptkhamur-13 , I believe you don't have an account on circle ci that's why those checks are failing , login into your account & those tests will pass ! |
|
Hi @HansujaB, thank you for the tip! I have now logged into CircleCI and authorized the account. The tests should be ready to run once a maintainer approves the workflow. Thanks again for the help! |
|
Hi @Dpereaptkhamur-13, thanks for opening the PR. Right now, the message has been added to Rather, the note should be included in Just make sure if you use this text to action the suggested changes: https://github.com/mne-tools/mne-python/pull/13664/changes#r2892847499 and https://github.com/mne-tools/mne-python/pull/13664/changes#r2892851172 Then, it would be good to also add a note to the |
|
Hi @tsbinns, thank you for the detailed feedback! That makes complete sense—moving the clarification to set_eeg_reference and the tutorials ensures it's visible to users regardless of which function they check first. I will update mne/utils/docs.py and the preprocessing tutorial file accordingly. I'll ping you again once the changes are pushed! |
Reference issue (if any)
What does this implement/fix?
This PR completes the documentation clarification for add_reference_channels originally started in #13664. It addresses the mathematical requirements for average referencing in the docstrings, as requested in issue #13618.
Changes include:
Additional information