aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/time/date.lux
blob: 7c79001e09352934f9b3b56ff686dba125dbd894 (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
41
42
43
44
45
46
(.using
 [library
  [lux (.except and)
   ["$" documentation (.only documentation:)]
   [control
    ["<>" parser
     ["<[0]>" code]]]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]
   [macro
    ["[0]" template]]]]
 [\\library
  ["[0]" /]])

(documentation: /.Date
  "A date specified as a year/month/day triplet.")

(documentation: /.date
  "A date, within the allowed limits."
  [(date year month day_of_month)])

(documentation: /.codec
  (format "Based on ISO 8601."
          \n "For example: 2017-01-15"))

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Date
             ..date
             ..codec
             ($.default /.invalid_day)
             ($.default /.epoch)
             ($.default /.year)
             ($.default /.month)
             ($.default /.day_of_month)
             ($.default /.equivalence)
             ($.default /.order)
             ($.default /.invalid_month)
             ($.default /.parser)
             ($.default /.days)
             ($.default /.of_days)
             ($.default /.enum)]
            []))