Warn even kernel size instead of halting#11
Closed
jomy-kk wants to merge 1 commit intoscientisst:mainfrom
Closed
Conversation
Wouldn't it be more friendly if BioSPPy solved for the user the issue of passing an even kernel size when median filtering? Because raising an error halts the program, which isn't necessary since it's not problematic. Here's a proposal to solve the issue and alert the user.
Member
rafaelscsilva
left a comment
There was a problem hiding this comment.
Thank you @jomy-kk for noticing this usability issue and proposing a solution, which is greatly appreciated. Instead of raising a Warning, I would suggest using the warnings Python module to achieve this since it prevents halting the program. To ensure good formatting in BioSPPy here's my suggestion:
- Add the
warningsmodule to the list of imports (preferably right after the compatibility imports)
# built-in
import warnings
- Change the
Warningexception to aUserWarning
warnings.warn("When the kernel is 'median', size must be odd, so the size was decremented by one.")
Let me know if this suggestion achieves the intended purpose of your PR. If so, I kindly ask you to update your PR with these changes.
Collaborator
|
Closed due to inactivity. Updates added in commit #66 |
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
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.
Wouldn't it be more friendly if BioSPPy solved for the user the issue of passing an even kernel size when median filtering? Because raising an error halts the program, which isn't necessary since it's not problematic. Here's a proposal to solve the issue and alert the user.