aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/sum.lux
blob: b7a41851dcf79b756d0ae7858e5013641430afb5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
(.require
 [library
  [lux (.except left right)
   ["$" documentation]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            "Functionality for working with variants (particularly 2-variants)."
            [($.definition /.lefts)
             ($.definition /.rights)
             ($.definition /.partition)
             ($.definition /.equivalence)
             ($.definition /.hash)

             ($.definition /.left
               "Lifts value to the left side of a 2-variant.")

             ($.definition /.right
               "Lifts value to the right side of a 2-variant.")

             ($.definition /.either
               "Applies a function to either side of a 2-variant."
               [(either on_left on_right)])

             ($.definition /.then
               "Applies functions to both sides of a 2-variant."
               [(then on_left on_right)])]
            []))