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: Add See Also links and Example graphs to filter design *ord functions #3234

Merged
merged 4 commits into from
Jan 23, 2014

Conversation

endolith
Copy link
Member

Also fixed a typo in a printed warning. Should that be converted to a raised warning or exception?

@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling a09d8dc on endolith:patch-3 into 6b6b41a on scipy:master.

See Also
--------
ellip : Filter design using order and critical points
buttord, cheb1ord, cheb2ord, : Find order and critical points
Copy link
Member

Choose a reason for hiding this comment

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

Remove the comma after cheb2ord, otherwise the doc build crashes

@rgommers
Copy link
Member

For the rest this looks good to me. Nice figures.

@endolith
Copy link
Member Author

Ok, fixed both of those.

@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling 19d71f5 on endolith:patch-3 into 6b6b41a on scipy:master.

rgommers added a commit that referenced this pull request Jan 23, 2014
Add See Also links and Example graphs to filter design *ord functions
@rgommers rgommers merged commit 7af62c8 into scipy:master Jan 23, 2014
@rgommers
Copy link
Member

Thanks, merging

@endolith
Copy link
Member Author

It looks like I screwed something up. The images show up on http://docs.scipy.org/doc/scipy-dev/reference/generated/scipy.signal.ellipord.html and http://docs.scipy.org/doc/scipy-dev/reference/generated/scipy.signal.buttord.html, but not on http://docs.scipy.org/doc/scipy-dev/reference/generated/scipy.signal.cheb1ord.html and http://docs.scipy.org/doc/scipy-dev/reference/generated/scipy.signal.cheb2ord.html Any idea why?

Also the lines like

butter, cheby1, cheby2, ellip, bessel : Filter design using order and
                                        critical points

are not working. I guess they can't have commas in them?

I could reword it to

butter : Filter design using order and critical points
cheby1, cheby2, ellip, bessel

also should have added an example/graph for iirdesign.

@rgommers
Copy link
Member

If you just paste the example into a clean IPython shell you'll see where it fails.The issue should be that you're using pi instead of np.pi. I failed to recheck the doc build after your last commit, my bad.

@rgommers
Copy link
Member

As for See Also, I think it's either a list of functions or a single function with a description behind it.

@endolith endolith restored the patch-3 branch January 29, 2014 14:46
@endolith
Copy link
Member Author

I tried to add the fixes to the same patch, but they're not showing up here, maybe because it's already been merged?

They are visible here: endolith@137ace8

@rgommers
Copy link
Member

You indeed can't add commits to a PR that has been merged already. I'll cherry-pick and push that commit (after double checking it).

@rgommers
Copy link
Member

rgommers commented Feb 2, 2014

Pushed doc fix commit in 28f9d10

@endolith endolith changed the title Add See Also links and Example graphs to filter design *ord functions DOC: Add See Also links and Example graphs to filter design *ord functions May 28, 2022
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

3 participants