aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/library/lux/data/color.lux
diff options
context:
space:
mode:
Diffstat (limited to 'stdlib/source/library/lux/data/color.lux')
-rw-r--r--stdlib/source/library/lux/data/color.lux26
1 files changed, 13 insertions, 13 deletions
diff --git a/stdlib/source/library/lux/data/color.lux b/stdlib/source/library/lux/data/color.lux
index ef2bff638..673e74e60 100644
--- a/stdlib/source/library/lux/data/color.lux
+++ b/stdlib/source/library/lux/data/color.lux
@@ -42,28 +42,28 @@
(|>> (f.* rgb_factor) f.int .nat))
(type: .public RGB
- {#.doc (doc "Red-Green-Blue color format.")}
+ {#.doc (example "Red-Green-Blue color format.")}
{#red Nat
#green Nat
#blue Nat})
(type: .public HSL
- {#.doc (doc "Hue-Saturation-Lightness color format.")}
+ {#.doc (example "Hue-Saturation-Lightness color format.")}
[Frac Frac Frac])
(type: .public CMYK
- {#.doc (doc "Cyan-Magenta-Yellow-Key color format.")}
+ {#.doc (example "Cyan-Magenta-Yellow-Key color format.")}
{#cyan Frac
#magenta Frac
#yellow Frac
#key Frac})
(type: .public HSB
- {#.doc (doc "Hue-Saturation-Brightness color format.")}
+ {#.doc (example "Hue-Saturation-Brightness color format.")}
[Frac Frac Frac])
(abstract: .public Color
- {#.doc (doc "A color value, independent of color format.")}
+ {#.doc (example "A color value, independent of color format.")}
RGB
@@ -128,7 +128,7 @@
(|> ..top (n.- value)))
(def: .public (complement color)
- {#.doc (doc "The opposite color.")}
+ {#.doc (example "The opposite color.")}
(-> Color Color)
(let [[red green blue] (:representation color)]
(:abstraction {#red (complement' red)
@@ -363,7 +363,7 @@
(syntax: (color_scheme_documentation {name <code>.local_identifier})
(let [name (text.replaced "_" "-" name)
g!documentation (code.text (format "A " name " color scheme."))]
- (in (list (` {#.doc (.doc (~ g!documentation))})))))
+ (in (list (` {#.doc (.example (~ g!documentation))})))))
(template [<name> <1> <2>]
[(`` (def: .public (<name> color)
@@ -412,7 +412,7 @@
(syntax: (palette_documentation {name <code>.local_identifier})
(let [name (text.replaced "_" "-" name)
g!documentation (code.text (format "A " name " palette."))]
- (in (list (` {#.doc (.doc (~ g!documentation))})))))
+ (in (list (` {#.doc (.example (~ g!documentation))})))))
(`` (def: .public (analogous spread variations color)
(~~ (..palette_documentation analogous))
@@ -439,25 +439,25 @@
of_hsb))))))
(type: .public Alpha
- {#.doc (doc "The degree of transparency of a pigment.")}
+ {#.doc (example "The degree of transparency of a pigment.")}
Rev)
(def: .public transparent
- {#.doc (doc "The maximum degree of transparency.")}
+ {#.doc (example "The maximum degree of transparency.")}
Alpha
rev\bottom)
(def: .public translucent
- {#.doc (doc "The average degree of transparency.")}
+ {#.doc (example "The average degree of transparency.")}
Alpha
.5)
(def: .public opaque
- {#.doc (doc "The minimum degree of transparency.")}
+ {#.doc (example "The minimum degree of transparency.")}
Alpha
rev\top)
(type: .public Pigment
- {#.doc (doc "A color with some degree of transparency.")}
+ {#.doc (example "A color with some degree of transparency.")}
{#color Color
#alpha Alpha})