Rename kwarg cs to colorscheme (#1)

Author: adrhill

docs/src/example.md

@@ -24,10 +24,10 @@ heatmap(val, words)
 We can use a custom color scheme from ColorSchemes.jl using the keyword argument cs:
 ```@example 1
 using ColorSchemes
-heatmap(val, words; cs=ColorSchemes.jet)
+heatmap(val, words; colorscheme=ColorSchemes.jet)
 ```
 ```@example 1
-heatmap(val, words; cs=ColorSchemes.inferno)
+heatmap(val, words; colorscheme=ColorSchemes.inferno)
 ```
 
 ## Mapping values onto the color scheme
@@ -55,11 +55,11 @@ heatmap(val, words; rangescale=:extrema)
 However, for the `inferno` color scheme, which is not centered around zero, `:extrema` leads to a heatmap with higher contrast.
 
 ```@example 1
-heatmap(val, words; cs=ColorSchemes.inferno, rangescale=:centered)
+heatmap(val, words; colorscheme=ColorSchemes.inferno, rangescale=:centered)
 ```
 
 ```@example 1
-heatmap(val, words; cs=ColorSchemes.inferno, rangescale=:extrema)
+heatmap(val, words; colorscheme=ColorSchemes.inferno, rangescale=:extrema)
 ```
 
 ## Terminal support

src/heatmap.jl

@@ -8,7 +8,7 @@ Create a heatmap of words where the background color of each word is determined
 Arguments `values` and `words` (and optionally `colors`) must have the same size.
 
 ## Keyword arguments
-- `cs::ColorScheme`: color scheme from ColorSchemes.jl that is applied to create the heatmap.
+- `colorscheme::ColorScheme`: color scheme from ColorSchemes.jl.
   Defaults to `ColorSchemes.seismic`.
 - `rangescale::Symbol`: selects how the color channel reduced heatmap is normalized
   before the color scheme is applied. Can be either `:extrema` or `:centered`.
@@ -37,12 +37,12 @@ struct TextHeatmap{
 end
 
 function TextHeatmap(
-    val, words; cs::ColorScheme=DEFAULT_COLORSCHEME, rangescale=DEFAULT_RANGESCALE
+    val, words; colorscheme::ColorScheme=DEFAULT_COLORSCHEME, rangescale=DEFAULT_RANGESCALE
 )
     if size(val) != size(words)
         throw(ArgumentError("Sizes of values and words don't match"))
     end
-    colors = get(cs, val, rangescale)
+    colors = get(colorscheme, val, rangescale)
     return TextHeatmap(val, words, colors)
 end
 

test/runtests.jl

@@ -16,9 +16,9 @@ using Aqua
         words = ["Test", "TextHeatmaps"]
         val = [4.2, -1.0]
 
-        cs = TextHeatmaps.seismic
-        cmin = get(cs, 0) # red
-        cmax = get(cs, 1) # blue
+        colorscheme = TextHeatmaps.seismic
+        cmin = get(colorscheme, 0) # red
+        cmax = get(colorscheme, 1) # blue
 
         # Test default ColorScheme seismic
         h = heatmap(val, words)
@@ -33,10 +33,10 @@ using Aqua
         @test_reference "references/seismic_extrema.txt" repr("text/plain", h)
 
         # Test other colorschemes
-        cs = ColorSchemes.inferno
-        h = heatmap(val, words; cs=cs, rangescale=:centered)
+        colorscheme = ColorSchemes.inferno
+        h = heatmap(val, words; colorscheme=colorscheme, rangescale=:centered)
         @test_reference "references/inferno_centered.txt" repr("text/plain", h)
-        h = heatmap(val, words; cs=cs, rangescale=:extrema)
+        h = heatmap(val, words; colorscheme=colorscheme, rangescale=:extrema)
         @test_reference "references/inferno_extrema.txt" repr("text/plain", h)
 
         # Test errors