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

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

        ($.definition /.empty)
        ($.definition /.size)
        ($.definition /.empty?)
        ($.definition /.equivalence)
        ($.definition /.functor)

        ($.definition (/.Stack it)
          "A first-in, last-out sequential data-structure.")

        ($.definition /.value
          "Yields the top value in the stack, if any."
          [(value stack)])

        ($.definition /.next
          ""
          [(next stack)])

        ($.definition /.top
          ""
          [(top value stack)])
        ))