aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation
diff options
context:
space:
mode:
authorEduardo Julian2022-11-21 16:40:51 -0400
committerEduardo Julian2022-11-21 16:40:51 -0400
commit224797231a8144f6ead1baab3b4b01a74cab629c (patch)
tree294aaadc4cc8dce8e40041aa318fa84de080002e /stdlib/source/documentation
parentdf0e015145981602b3f97113bcfa586b4f6d0757 (diff)
Added index section to documentation + re-named Primitive -> Nominal
Diffstat (limited to 'stdlib/source/documentation')
-rw-r--r--stdlib/source/documentation/lux.lux14
-rw-r--r--stdlib/source/documentation/lux/data/collection/array.lux2
-rw-r--r--stdlib/source/documentation/lux/data/color.lux13
-rw-r--r--stdlib/source/documentation/lux/data/color/named.lux9
-rw-r--r--stdlib/source/documentation/lux/meta/type.lux8
-rw-r--r--stdlib/source/documentation/lux/meta/type/linear.lux (renamed from stdlib/source/documentation/lux/meta/type/resource.lux)0
-rw-r--r--stdlib/source/documentation/lux/meta/type/nominal.lux (renamed from stdlib/source/documentation/lux/meta/type/primitive.lux)0
7 files changed, 19 insertions, 27 deletions
diff --git a/stdlib/source/documentation/lux.lux b/stdlib/source/documentation/lux.lux
index 84fb5c9d7..07e6a2dc2 100644
--- a/stdlib/source/documentation/lux.lux
+++ b/stdlib/source/documentation/lux.lux
@@ -225,10 +225,10 @@
($.comment "=>")
($.example "Aw hell naw!"))
- ($.definition /.Primitive
- "Macro to treat define new primitive types."
- ($.example (Primitive "java.lang.Object"))
- ($.example (Primitive "java.util.List" [(Primitive "java.lang.Long")])))
+ ($.definition /.Nominal
+ "Macro to treat define new nominal types."
+ ($.example (Nominal "java.lang.Object"))
+ ($.example (Nominal "java.util.List" [(Nominal "java.lang.Long")])))
($.definition /.`
(format "Hygienic quasi-quotation as a macro."
@@ -324,7 +324,7 @@
($.example (type Type
(Rec @
(Variant
- {#Primitive Text (List @)}
+ {#Nominal Text (List @)}
{#Sum @ @}
{#Product @ @}
{#Function @ @}
@@ -642,8 +642,8 @@
... ($.example (def (reduced env type)
... (-> (List Type) Type Type)
... (when type
- ... {.#Primitive name params}
- ... {.#Primitive name (list#each (reduced env) params)}
+ ... {.#Nominal name params}
+ ... {.#Nominal name (list#each (reduced env) params)}
... (^with_template [<tag>]
... [{<tag> left right}
diff --git a/stdlib/source/documentation/lux/data/collection/array.lux b/stdlib/source/documentation/lux/data/collection/array.lux
index 0f2c5094f..b806af2a4 100644
--- a/stdlib/source/documentation/lux/data/collection/array.lux
+++ b/stdlib/source/documentation/lux/data/collection/array.lux
@@ -15,7 +15,7 @@
(list ($.module /._
"")
- ($.definition /.primitive)
+ ($.definition /.nominal)
($.definition /.equivalence)
($.definition /.monoid)
($.definition /.functor)
diff --git a/stdlib/source/documentation/lux/data/color.lux b/stdlib/source/documentation/lux/data/color.lux
index 77162cec2..768fb1ffb 100644
--- a/stdlib/source/documentation/lux/data/color.lux
+++ b/stdlib/source/documentation/lux/data/color.lux
@@ -24,10 +24,7 @@
(`` (def .public documentation
(List $.Documentation)
- (let [encoding (list ($.definition /.RGB
- "Red-Green-Blue color format.")
-
- ($.definition /.of_rgb)
+ (let [encoding (list ($.definition /.of_rgb)
($.definition /.rgb)
($.definition /.HSL
@@ -36,17 +33,11 @@
($.definition /.hsl)
($.definition /.of_hsl)
- ($.definition /.CMYK
- "Cyan-Magenta-Yellow-Key color format.")
-
($.definition /.hsb)
($.definition /.of_hsb)
($.definition /.HSB
- "Hue-Saturation-Brightness color format.")
-
- ($.definition /.cmyk)
- ($.definition /.of_cmyk))
+ "Hue-Saturation-Brightness color format."))
transformation (list ($.definition /.gray_scale)
($.definition /.darker)
($.definition /.brighter)
diff --git a/stdlib/source/documentation/lux/data/color/named.lux b/stdlib/source/documentation/lux/data/color/named.lux
index cd4e683e0..49eb0847d 100644
--- a/stdlib/source/documentation/lux/data/color/named.lux
+++ b/stdlib/source/documentation/lux/data/color/named.lux
@@ -12,16 +12,17 @@
["[0]" nat (.use "hex#[0]" hex)]]]]]
[\\library
["[0]" / (.only)
- ["/[1]" //]]])
+ ["/[1]" // (.only)
+ ["[0]" rgb]]]])
(def description
(template (_ <name>)
[($.definition <name>
(let [[red green blue] (//.rgb <name>)
[_ name] (symbol <name>)]
- (format "R:" (hex#encoded red)
- " G:" (hex#encoded green)
- " B:" (hex#encoded blue)
+ (format "R:" (hex#encoded (rgb.number red))
+ " G:" (hex#encoded (rgb.number green))
+ " B:" (hex#encoded (rgb.number blue))
" | " (text.replaced "_" " " name))))]))
(`` (def .public documentation
diff --git a/stdlib/source/documentation/lux/meta/type.lux b/stdlib/source/documentation/lux/meta/type.lux
index 292b084f2..b61ba2afd 100644
--- a/stdlib/source/documentation/lux/meta/type.lux
+++ b/stdlib/source/documentation/lux/meta/type.lux
@@ -14,14 +14,14 @@
[\\library
["[0]" /]]
["[0]" /
- ["[1][0]" primitive]
+ ["[1][0]" nominal]
["[1][0]" check]
["[1][0]" dynamic]
["[1][0]" implicit]
["[1][0]" poly]
["[1][0]" quotient]
["[1][0]" refinement]
- ["[1][0]" resource]
+ ["[1][0]" linear]
["[1][0]" unit]
["[1][0]" variance]])
@@ -269,14 +269,14 @@
(all list#composite
..\\parser
- /primitive.documentation
+ /nominal.documentation
/check.documentation
/dynamic.documentation
/implicit.documentation
/poly.documentation
/quotient.documentation
/refinement.documentation
- /resource.documentation
+ /linear.documentation
/unit.documentation
/variance.documentation
)
diff --git a/stdlib/source/documentation/lux/meta/type/resource.lux b/stdlib/source/documentation/lux/meta/type/linear.lux
index c8e34ab6e..c8e34ab6e 100644
--- a/stdlib/source/documentation/lux/meta/type/resource.lux
+++ b/stdlib/source/documentation/lux/meta/type/linear.lux
diff --git a/stdlib/source/documentation/lux/meta/type/primitive.lux b/stdlib/source/documentation/lux/meta/type/nominal.lux
index 036489d22..036489d22 100644
--- a/stdlib/source/documentation/lux/meta/type/primitive.lux
+++ b/stdlib/source/documentation/lux/meta/type/nominal.lux