aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/reader.lux
blob: 33f324843b3960fe8e3e7b6bf08671b963af8545 (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
35
36
37
38
39
40
(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Documentation)
  (list ($.module /._
                  "")

        ($.definition /.functor)
        ($.definition /.apply)
        ($.definition /.monad)

        ($.definition (/.Reader environment it)
          "Computations that have access to some environmental value.")

        ($.definition /.read
          "Get the environment.")

        ($.definition /.local
          "Run computation with a locally-modified environment."
          [(local change proc)])

        ($.definition /.result
          "Executes the reader against the given environment."
          [(result env proc)])

        ($.definition /.with
          "Monad transformer for Reader."
          [(with monad)])

        ($.definition /.lifted
          "Lift monadic values to the Reader wrapper.")
        ))