improve docs, reduce dependecies

Author: t-bltg

AsciiPixel/src/ascii.jl

@@ -24,8 +24,8 @@ Larger images are downscaled automatically using `restrict`.
 
 Returns
     1. Downscaled image
-    2. Selected encoder with `size` containing:
-        1. number of lines in the vector.
+    2. Selected encoder (big or small blocks) with `size` containing:
+        1. number of lines in the Vector{String}.
         2. number of visible characters per line (the remaining are colorcodes).
 """
 function downscale_small(img::AbstractMatrix{<:Colorant}, maxheight::Int, maxwidth::Int)
@@ -187,6 +187,7 @@ function ascii_encode(
     ret ? readlines(io) : nothing
 end
 
+# uses a `PipeBuffer` as io and returns encoded data reading lines of this buffer
 ascii_encode(enc::SmallBlocks, args...) =
     ascii_encode(PipeBuffer(), enc, args...; ret=true)
 
@@ -208,7 +209,6 @@ based on the current display size. The image will also be
 downsampled to fit into the display (using `restrict`).
 """
 
-# colorant matrix
 function ascii_display(
     io::IO,
     img::AbstractMatrix{<:Colorant},
@@ -224,7 +224,6 @@ function ascii_display(
     io
 end
 
-# colorant vector
 function ascii_display(
     io::IO,
     img::AbstractVector{<:Colorant},
@@ -240,5 +239,6 @@ function ascii_display(
     io
 end
 
+# ascii_display, using the default colormode
 ascii_display(io::IO, img::AbstractArray{<:Colorant}; kwargs...) =
     ascii_display(io, img, colormode[]; kwargs...)

Project.toml

@@ -4,14 +4,14 @@ version = "0.4.7"
 
 [deps]
 AsciiPixel = "d64ea8f1-9d40-4cda-bb88-5de2505cd5c8"
+ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"
 Crayons = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
-ImageCore = "a09fc81d-aa75-5fe9-8630-4744c3626534"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 
 [compat]
 AsciiPixel = "0.1"
+ColorTypes = "0.9 - 0.11"
 Crayons = "1 - 4"
-ImageCore = "0.9"
 Requires = "1"
 julia = "1.6"
 

src/ImageInTerminal.jl

@@ -1,7 +1,7 @@
 module ImageInTerminal
 
 using AsciiPixel
-using ImageCore
+using ColorTypes
 using Requires
 using Crayons
 
@@ -31,7 +31,12 @@ different encoding method, call `AsciiPixel.use_256()` or `AsciiPixel.use_24bit(
 """
 enable_encoding() = (should_render_image[] = true)
 
-function use_sixel(img::AbstractArray)
+"""
+    choose_sixel(img::AbstractArray)
+
+Choose to encode the image using sixels based on the size of the encoded image.
+"""
+function choose_sixel(img::AbstractArray)
     encoder_backend[] == :Sixel || return false
 
     # Sixel requires at least 6 pixels in row direction and thus doesn't perform very well for vectors.
@@ -85,15 +90,19 @@ terminal colors (defaults to 256 colors).
 
 If working in the REPL, the function tries to choose the encoding
 based on the current display size. The image will also be
-downsampled to fit into the display (using `restrict`).
+downsampled to fit into the display.
+
+Supported encoding:
+    - sixel (`Sixel` backend)
+    - ascii (`AsciiPixel` backend)
 """
 
 function imshow(
     io::IO,
     img::AbstractArray{<:Colorant},
     maxsize::Tuple = displaysize(io)
 )
-    if use_sixel(img)
+    if choose_sixel(img)
         sixel_encode(io, img)
     else
         if ndims(img) > 2

test/runtests.jl

@@ -1,12 +1,12 @@
 using Test, TestImages, ReferenceTests
 using OffsetArrays, SparseArrays
 using CoordinateTransformations
-using ImageBase, ImageCore
 using ImageTransformations
 using ImageQualityIndexes
 using ImageInTerminal
 using ImageMagick
 using AsciiPixel
+using ImageBase
 using Rotations
 
 import ImageInTerminal: imshow
@@ -35,7 +35,7 @@ end
 
 include(joinpath(dirname(pathof(AsciiPixel)), "..", "test", "common.jl"))
 
-# deprecated functions
+# deprecated functions, kept for testing
 function imshow256(args...)
     old_colormode = AsciiPixel.colormode[]
     AsciiPixel.set_colordepth(8)
@@ -52,7 +52,7 @@ end
 
 ImageInTerminal.encoder_backend[] = :ImageInTerminal  # manually disable Sixel
 for t in tests
-    @testset "$t" begin
+    @testset "$t" begins
         include(t)
     end
 end