JuliaImages / DitherPunk.jl

Dithering algorithms in Julia.
MIT License
60 stars 3 forks source link

fix docstring dispatch #56

Closed johnnychen94 closed 2 years ago

johnnychen94 commented 2 years ago

This fixes the following warning:

julia> using DitherPunk

julia> using Clustering
┌ Warning: Replacing docs for `DitherPunk.dither! :: Union{}` in module `DitherPunk`
└ @ Base.Docs docs/Docs.jl:240
┌ Warning: Replacing docs for `DitherPunk.dither :: Union{}` in module `DitherPunk`
└ @ Base.Docs docs/Docs.jl:240

help?> dither
search: dither dither! DitherPunk OrderedDither isdispatchtuple

  dither([T::Type,] img, alg::AbstractDither, ncolors; maxiter, tol, kwargs...)

  Dither image img using algorithm alg. A color palette with ncolors is computed by Clustering.jl's K-means clustering. The amount of
  maxiter and tolerance tol default to those exported by Clustering.jl.

After: two pieces of method docstring

julia> using DitherPunk

julia> using Clustering

help?> dither
search: dither dither! DitherPunk OrderedDither isdispatchtuple

  dither([T::Type,] img, alg::AbstractDither, args...; kwargs...)

  Dither image img using algorithm alg.

  Output
  ≡≡≡≡≡≡≡≡

  If no return type is specified, dither will default to the type of the input image.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

  dither([T::Type,] img, alg::AbstractDither, ncolors; maxiter, tol, kwargs...)

  Dither image img using algorithm alg. A color palette with ncolors is computed by Clustering.jl's K-means clustering. The amount of
  maxiter and tolerance tol default to those exported by Clustering.jl.
codecov[bot] commented 2 years ago

Codecov Report

Merging #56 (ba205fd) into master (0cb8792) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #56   +/-   ##
=======================================
  Coverage   96.38%   96.38%           
=======================================
  Files          14       14           
  Lines         221      221           
=======================================
  Hits          213      213           
  Misses          8        8           
Impacted Files Coverage Δ
src/clustering.jl 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 0cb8792...ba205fd. Read the comment docs.

adrhill commented 2 years ago

Perfect, thanks!