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.

Sign up for GitHub

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

Jump to bottom

Improve imfilter docstring #184

Closed
juliohm opened this issue Sep 14, 2020 · 2 comments
Closed

Improve imfilter docstring #184

juliohm opened this issue Sep 14, 2020 · 2 comments

Comments

@juliohm
Copy link
Member

juliohm commented Sep 14, 2020

The imfilter docstring is an amazing learning resource, but I think it is not addressing the goal of a docstring. In my opinion, the docstring should clarify the usage of the function and explain the options quickly via examples. Currently, however, it explains what is a filtering operation, differences between correlation and convolution, and a lot of related theoretical results, which aren't very useful. This information is appropriate for the official docs, but are not appropriate in the docstring. Additionally, the docstring contains LaTeX code which is not properly displayed in the REPL.
@timholy
Copy link
Member

timholy commented Sep 14, 2020

#151, #153

@timholy timholy closed this as completed Sep 14, 2020
@timholy
Copy link
Member

timholy commented Sep 14, 2020

Just waiting for a volunteer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@timholy @juliohm