summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2021-04-25 15:51:31 -0500
committerJeremy Evans <code@jeremyevans.net>2021-04-29 19:58:15 -0700
commit6ee55455a88d0f3542497b429d496abaf01fd353 (patch)
tree69163153cba44b59e537fb52336922fe1e19c718 /doc
parent5a451c4b1f7f7bbd6607cb3f32f3ddd98e064971 (diff)
Update Time documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/time/in.rdoc7
-rw-r--r--doc/time/mon-min.rdoc8
-rw-r--r--doc/time/msec.rdoc2
-rw-r--r--doc/time/nsec.rdoc2
-rw-r--r--doc/time/sec.rdoc2
-rw-r--r--doc/time/sec_i.rdoc1
-rw-r--r--doc/time/usec.rdoc2
-rw-r--r--doc/time/year.rdoc1
8 files changed, 25 insertions, 0 deletions
diff --git a/doc/time/in.rdoc b/doc/time/in.rdoc
new file mode 100644
index 0000000000..f47db76a35
--- /dev/null
+++ b/doc/time/in.rdoc
@@ -0,0 +1,7 @@
+- <tt>in: zone</tt>: a timezone _zone_, which may be:
+ - A string offset from UTC.
+ - A single letter offset from UTC, in the range <tt>'A'..'Z'</tt>,
+ <tt>'J'</tt> (the so-called military timezone) excluded.
+ - An integer number of seconds.
+ - A timezone object;
+ see {Timezone Argument}[#class-Time-label-Timezone+Argument] for details.
diff --git a/doc/time/mon-min.rdoc b/doc/time/mon-min.rdoc
new file mode 100644
index 0000000000..5bd430c74a
--- /dev/null
+++ b/doc/time/mon-min.rdoc
@@ -0,0 +1,8 @@
+- +month+: a month value, which may be:
+ - An integer month in the range <tt>1..12</tt>.
+ - A 3-character string that matches regular expression
+ <tt>/jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec/i</tt>.
+- +day+: an integer day in the range <tt>1..31</tt>
+ (less than 31 for some months).
+- +hour+: an integer hour in the range <tt>0..23</tt>.
+- +min+: an integer minute in the range <tt>0..59</tt>.
diff --git a/doc/time/msec.rdoc b/doc/time/msec.rdoc
new file mode 100644
index 0000000000..ce5d1e6145
--- /dev/null
+++ b/doc/time/msec.rdoc
@@ -0,0 +1,2 @@
+- +msec+ is the number of milliseconds (Integer, Float, or Rational)
+ in the range <tt>0..1000</tt>.
diff --git a/doc/time/nsec.rdoc b/doc/time/nsec.rdoc
new file mode 100644
index 0000000000..a2dfe2d608
--- /dev/null
+++ b/doc/time/nsec.rdoc
@@ -0,0 +1,2 @@
+- +nsec+ is the number of nanoseconds (Integer, Float, or Rational)
+ in the range <tt>0..1000000000</tt>.
diff --git a/doc/time/sec.rdoc b/doc/time/sec.rdoc
new file mode 100644
index 0000000000..049c712110
--- /dev/null
+++ b/doc/time/sec.rdoc
@@ -0,0 +1,2 @@
+- +sec+ is the number of seconds (Integer, Float, or Rational)
+ in the range <tt>0..60</tt>.
diff --git a/doc/time/sec_i.rdoc b/doc/time/sec_i.rdoc
new file mode 100644
index 0000000000..99c8eddc65
--- /dev/null
+++ b/doc/time/sec_i.rdoc
@@ -0,0 +1 @@
+- +isec_i+ is the integer number of seconds in the range <tt>0..60</tt>.
diff --git a/doc/time/usec.rdoc b/doc/time/usec.rdoc
new file mode 100644
index 0000000000..bb5a46419a
--- /dev/null
+++ b/doc/time/usec.rdoc
@@ -0,0 +1,2 @@
+- +usec+ is the number of microseconds (Integer, Float, or Rational)
+ in the range <tt>0..1000000</tt>.
diff --git a/doc/time/year.rdoc b/doc/time/year.rdoc
new file mode 100644
index 0000000000..2222b830d7
--- /dev/null
+++ b/doc/time/year.rdoc
@@ -0,0 +1 @@
+- +year+: an integer year.