aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/library/lux/time.lux
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--stdlib/source/library/lux/time.lux16
1 files changed, 11 insertions, 5 deletions
diff --git a/stdlib/source/library/lux/time.lux b/stdlib/source/library/lux/time.lux
index dbe7ff1fa..9429e7081 100644
--- a/stdlib/source/library/lux/time.lux
+++ b/stdlib/source/library/lux/time.lux
@@ -23,15 +23,20 @@
[/
["." duration (#+ Duration)]])
-(template [<name> <singular> <plural>]
+(template [<name> <singular> <plural> <doc>]
[(def: .public <name>
+ {#.doc (example <doc>)}
Nat
(.nat (duration.ticks <singular> <plural>)))]
- [milli_seconds duration.milli_second duration.second]
- [seconds duration.second duration.minute]
- [minutes duration.minute duration.hour]
- [hours duration.hour duration.day]
+ [milli_seconds duration.milli_second duration.second
+ "Number of milli-seconds in a second."]
+ [seconds duration.second duration.minute
+ "Number of seconds in a minute."]
+ [minutes duration.minute duration.hour
+ "Number of minutes in an hour."]
+ [hours duration.hour duration.day
+ "Number of hours in an day."]
)
(def: limit
@@ -169,6 +174,7 @@
($_ text\compose "." (n\encode millis))))
(type: .public Clock
+ {#.doc (example "A clock marking the specific hour, minute, second, and milli-second in a day.")}
{#hour Nat
#minute Nat
#second Nat