You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
What does this implement/fix? Explain your changes.
Fixes minor typos in transformations/series/boxcox.py
Does your contribution introduce a new dependency? If yes, which one?
No.
What should a reviewer concentrate their feedback on?
The function _eval_pearsonr is an inline function, I've slightly changed the docstring, but haven't converted it to a standard function docstr. Is it ok?
Pydocstyle's suggestions seem irrelevant in these cases to me.
Should I add docstring to these 3 methods?
line 47 in public method fit: D102: Missing docstring in public method
line 57 in public method transform: D102: Missing docstring in public method
line 63 in public method inverse_transform: D102: Missing docstring in public method
And I'm still not sure about _eval_pearsonr:
sktime/transformations/series/boxcox.py:114 in private nested function _eval_pearsonr: D205: 1 blank line required between summary line and description (found 0)
sktime/transformations/series/boxcox.py:114 in private nested function _eval_pearsonr: D400: First line should end with a period (not 't')
What to do generally? Just follow the pydocstyle (because if anybody changes this file in the future will get the same code-check error)? Asking core contributors every time doesn't seem like a good idea 🤔
Thanks for raising these questions, I feel that fixing the documentation is very important for us at this stage and that we can still achieve this through the automated CI checks but happy to discuss this again in a few weeks if it causes too much trouble!
Hi @mloning ! I've added docstrings to fit, transform and inverse_transform , thanks for the hint, it helped a lot.
I looked at the pydocstyle link you sent, thank you, it's a great resource! Removed docstr for _eval_pearsonr as it's not required for inside nested function.
I think now the PR is ready for review.
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
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.
Fixes #884 (partially)
What does this implement/fix? Explain your changes.
Fixes minor typos in
transformations/series/boxcox.pyDoes your contribution introduce a new dependency? If yes, which one?
No.
What should a reviewer concentrate their feedback on?
The function
_eval_pearsonris an inline function, I've slightly changed the docstring, but haven't converted it to a standard function docstr. Is it ok?