Skip to content

The docstring for peakdet.operations.filter_physio is wrong #25

Description

@bbfrederick

The docstring for peakdet.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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

BugSomething isn't working

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions