aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/sum.lux
diff options
context:
space:
mode:
Diffstat (limited to 'stdlib/source/documentation/lux/data/sum.lux')
-rw-r--r--stdlib/source/documentation/lux/data/sum.lux40
1 files changed, 40 insertions, 0 deletions
diff --git a/stdlib/source/documentation/lux/data/sum.lux b/stdlib/source/documentation/lux/data/sum.lux
new file mode 100644
index 000000000..5db8a4df3
--- /dev/null
+++ b/stdlib/source/documentation/lux/data/sum.lux
@@ -0,0 +1,40 @@
+(.module:
+ [library
+ [lux #*
+ ["$" documentation (#+ documentation:)]
+ [data
+ [text (#+ \n)
+ ["%" format (#+ format)]]]
+ [macro
+ ["." template]]]]
+ [\\library
+ ["." /]])
+
+(documentation: /.left
+ "Lifts value to the left side of a 2-variant.")
+
+(documentation: /.right
+ "Lifts value to the right side of a 2-variant.")
+
+(documentation: /.either
+ "Applies a function to either side of a 2-variant."
+ [(either on_left on_right)])
+
+(documentation: /.then
+ "Applies functions to both sides of a 2-variant."
+ [(then on_left on_right)])
+
+(.def: .public documentation
+ (.List $.Module)
+ ($.module /._
+ "Functionality for working with variants (particularly 2-variants)."
+ [..left
+ ..right
+ ..either
+ ..then
+ ($.default /.lefts)
+ ($.default /.rights)
+ ($.default /.partition)
+ ($.default /.equivalence)
+ ($.default /.hash)]
+ []))