search

JuliaImages / ImageFiltering.jl

Julia implementations of multidimensional array convolution and nonlinear stencil operations
Other
99 stars 49 forks source link

Improve imfilter docstring #184

Closed juliohm closed 4 years ago

juliohm commented 4 years ago

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 commented 4 years ago

151, #153

timholy commented 4 years ago

Just waiting for a volunteer!