MRG, DOC: Make clear which functions have been renamed#8372
Merged
larsoner merged 1 commit intomne-tools:masterfrom Oct 15, 2020
Merged
MRG, DOC: Make clear which functions have been renamed#8372larsoner merged 1 commit intomne-tools:masterfrom
larsoner merged 1 commit intomne-tools:masterfrom
Conversation
agramfort
approved these changes
Oct 15, 2020
Member
|
For PRs that change doc only it's better to do |
Member
Author
Damn, sorry, this is exactly what I thought |
Member
|
Thanks @hoechenberger |
larsoner
pushed a commit
that referenced
this pull request
Oct 15, 2020
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.
@SophieHerbst got lost because after an MNE update,
mne.channels.find_ch_connectivityandmne.channels.read_ch_connectivitywere gone. Turns out these functions were renamerd, and this change was mentioned in the changelog indeed, but apparently not explicitly enough. Searching the docs for the function name wouldn't bring up helpful results either. This PR explicitly lists all*connectivityfunctions that have been renamed to*adjacencyin the changelog, so it should be easier to discover these changes.