Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fold_events accepts keywords and ignores them #835

Closed
matteobachetti opened this issue Aug 12, 2024 · 2 comments
Closed

fold_events accepts keywords and ignores them #835

matteobachetti opened this issue Aug 12, 2024 · 2 comments
Labels
help wanted We need additional help with these issues!

Comments

@matteobachetti
Copy link
Member

Description of the Issue

A recently reported bug showed that people were using the fdot keyword in fold_events. This keyword does not exist, but the function is accepting it and ignoring it due to the use of **kwargs. Using such a name for this keyword is understandable, as it's used in other functions, and not having an error people assume it's correct.

Your suggestions for the Fix

I suggest adding a check and a warning, or even a ValueError, for ignored keywords.

@matteobachetti matteobachetti added the help wanted We need additional help with these issues! label Aug 12, 2024
@spranav1205
Copy link
Contributor

Hi,
I have written a fix for this, PR #837. I noticed that fdot is a parameter, although it does not need a keyword to be passed.
The description of the function mentions this, but it might not be clear to the user.

@matteobachetti
Copy link
Member Author

Resolved by #837

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We need additional help with these issues!
Projects
None yet
Development

No branches or pull requests

2 participants