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

DOC: A typo in ValueError raised by signal.iirdesign #20683

Closed
budjen-jovan opened this issue May 9, 2024 · 2 comments · Fixed by #20684
Closed

DOC: A typo in ValueError raised by signal.iirdesign #20683

budjen-jovan opened this issue May 9, 2024 · 2 comments · Fixed by #20684
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks scipy.signal
Milestone

Comments

@budjen-jovan
Copy link
Contributor

budjen-jovan commented May 9, 2024

Issue with current documentation:

Currently, in signal.iirdesign there is an error message being thrown:
raise ValueError("wp and ws must have one or two elements each, and" f"the same shape, got {wp.shape} and {ws.shape}")
There is a missing whitespace between the two strings (github messes up the formatting, I can't figure out how to format this properly.
A resulting error message being thrown is

ValueError: wp and ws must have one or two elements each, andthe same shape, got (4,) and (2,)

Idea or request for content:

Again, looking at the existing solutions in the code (although they are not very consistent about this), I suggest adding a whitespace to the end of the first string or the beginning of the other string. There is a slight styling problem where the two solutions are being used interchangably - it doesn't break functionality in any way, it's just not pretty to look at. I suppose I can fix that, it's trivial, but I'm not sure if that's a change worth doing, do let me know.

Additional context (e.g. screenshots, GIFs)

No response

@budjen-jovan budjen-jovan added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label May 9, 2024
@lucascolley
Copy link
Member

PR welcome if you would like to fix it!

@lucascolley lucascolley added the maintenance Items related to regular maintenance tasks label May 9, 2024
@lucascolley lucascolley added this to the 1.14.0 milestone May 9, 2024
@budjen-jovan
Copy link
Contributor Author

Absolutely, will do in a sec

budjen-jovan added a commit to budjen-jovan/scipy that referenced this issue May 9, 2024
As per scipy#20683, added the missing whitespace, and moved existing whitespace separators to the end of first strings for consistency
j-bowhay pushed a commit that referenced this issue May 10, 2024
…20684)

As per #20683, added the missing whitespace, and moved existing whitespace separators to the end of first strings for consistency
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 maintenance Items related to regular maintenance tasks scipy.signal
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants