[DOC] Fix misleading fit_transform docstrings#12827
Merged
drammock merged 4 commits intomne-tools:mainfrom Sep 6, 2024
Merged
Conversation
Contributor
Author
|
Some tests failing for unrelated parts of the |
Contributor
Author
|
A couple more sklearn compliance checks are being run in the dev version than the stable v1.5, including the following which are causing problems (there might be others, these are just the first ones to fail):
Is it sufficient that the failing ones are added to the list of ignored checks? Also, when I checked the logs to see why this wasn't failing for the dev branch on Ubuntu, I see that the same tests are failing, but the operation gets cancelled before the tests can finish running and it reports a pass overall. Is this intended behaviour? |
Member
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.
Reference issue
Example: Addresses #12766.
What does this implement/fix?
Adds custom docstrings for the
fit_transformmethod of theCSP,SPoC, andSSDclasses of thedecodingmodule. The docstrings now accurately reflect the parameters of thefitandtransformmethods for each class (previously used the generic docstring ofTransformerMixin).