aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/writer.lux
blob: e74e6b47d86871a9357e4ccaadf4d0625176fefc (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
(.require
 [library
  [lux (.except local)
   ["$" documentation]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.functor)
             ($.default /.apply)
             ($.default /.monad)

             ($.definition (/.Writer log value)
               "Represents a value with an associated 'log' to record arbitrary information.")

             ($.definition /.write
               "Write a value to the log."
               [(write message)])

             ($.definition /.with
               "Enhances a monad with Writer functionality."
               [(with monoid monad)])

             ($.definition /.lifted
               "Wraps a monadic value with Writer machinery."
               [(lifted monoid monad)])]
            []))