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: Added examples for zpk2tf, tf2sos, sos2tf, lp2lp_zpk, lp2hp_zpk, lp2bp_zpk, lp2bs_zpk functions #19218

Merged
merged 12 commits into from Sep 15, 2023

Conversation

tamri
Copy link
Contributor

@tamri tamri commented Sep 10, 2023

Reference issue
DOC: Add "Examples" to docstrings #7168

What does this implement/fix?
Added examples for zpk2tf, tf2sos, sos2tf, lp2lp_zpk, lp2hp_zpk, lp2bp_zpk, lp2bs_zpk functions
The code can be found in scipy/signal/_filter_design.py

Additional information
[skip actions] [skip cirrus]

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tamri, some suggestions

scipy/signal/_filter_design.py Outdated Show resolved Hide resolved
scipy/signal/_filter_design.py Outdated Show resolved Hide resolved
scipy/signal/_filter_design.py Outdated Show resolved Hide resolved
@tamri
Copy link
Contributor Author

tamri commented Sep 11, 2023

Hey @j-bowhay, I made changes accordingly.
Let me know if anything else needs fixing. thx

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refguide check / doc build needs fixing. Looks like some of the docstrings need converting to raw strings (r""") and some of the expected outputs are wrong

@tamri
Copy link
Contributor Author

tamri commented Sep 15, 2023

@j-bowhay It seems like all checks passed. Can you please take another look at this PR.
Appreciate your patience :)

@tamri tamri requested a review from j-bowhay September 15, 2023 02:09
scipy/signal/_filter_design.py Outdated Show resolved Hide resolved
scipy/signal/_filter_design.py Outdated Show resolved Hide resolved
scipy/signal/_filter_design.py Outdated Show resolved Hide resolved
tamri and others added 4 commits September 15, 2023 18:26
Co-authored-by: Jake Bowhay <60778417+j-bowhay@users.noreply.github.com>
Co-authored-by: Jake Bowhay <60778417+j-bowhay@users.noreply.github.com>
Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tamri

@j-bowhay j-bowhay added scipy.signal Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Sep 15, 2023
@j-bowhay j-bowhay added this to the 1.12.0 milestone Sep 15, 2023
@j-bowhay j-bowhay merged commit 9df7042 into scipy:main Sep 15, 2023
22 of 24 checks passed
@tamri tamri deleted the docustring-examples branch September 18, 2023 03:58
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

Successfully merging this pull request may close these issues.

None yet

2 participants