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

The docstring for operations.filter_physio is wrong #86

Open
bbfrederick opened this issue Jan 21, 2025 · 0 comments
Open

The docstring for operations.filter_physio is wrong #86

bbfrederick opened this issue Jan 21, 2025 · 0 comments
Assignees
Labels
Bug Something isn't working

Comments

@bbfrederick
Copy link

The docstring for operations.filter_physio is wrong

Expected Behavior

The type of cutoffs should be "float or list" rather than "int or list"

The documentation describes the cutoff frequency arguments as integers, when they should actually be floats.

Actual Behavior

The description of cutoffs says the type is "int or list", it should be "float or list". This is only cosmetic. You can pass floats to cutoff, and they work as expected.

Steps to Reproduce the Problem

1.
2.
3.

Specifications

- Python version:
- peakdet version:
- Platform:

Possible solution

Fix the docstring

@bbfrederick bbfrederick added the Bug Something isn't working label Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant