JuliaImages / JuliaImages/ImageFiltering.jl

imgradients documentation is confusing

Open
#211 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation question
Dominant language
Julia
Stars
104
Forks
52
PR merge metrics
No merged PRs in 30d

Description

if i try to do

imgradients(testimage("chelsea"))

i get

MethodError: no method matching imgradients(::Array{RGB{Normed{UInt8,8}},2})
Closest candidates are:
  imgradients(::AbstractArray, !Matched::Function) at ~/.julia/packages/ImageFiltering/nipv3/src/specialty.jl:500
  imgradients(::AbstractArray, !Matched::Function, !Matched::Any) at ~/.julia/packages/ImageFiltering/nipv3/src/specialty.jl:500

the documentation seems to suggest that this should work?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the imgradients methods at src/specialty.jl:500 and compare them with the documentation that suggests imgradients(testimage("chelsea")) should work. Clarify the documented call or usage so it matches the available method signatures, then verify the example no longer produces the reported MethodError.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
computer-vision, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.