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

signal: Clarify behavior of *ord functions and improve test documentation #9067

Open
endolith opened this issue Jul 23, 2018 · 0 comments
Open
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.signal

Comments

@endolith
Copy link
Member

As described in #8397 (comment):

How did you derive such precise values for the expected results? Add a comment [in the test code] explaining where these numbers came from, so future maintainers can reproduce those expected values.

Or the values should be set to only test whether it meets the actual spec?

But in many cases, there's "wiggle room" in which the filter can vary while still meeting the spec, described here: #3219 (comment)

(buttord's hugging behavior was changed in #3235 (comment) )

The behavior of whether it will hug the inner or outer constraint should be defined in the docstrings, and it would be good to test this to make sure it stays consistent.

@pvanmulbregt pvanmulbregt added scipy.signal Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Jul 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.signal
Projects
None yet
Development

No branches or pull requests

2 participants