Breaking change: Normalise inside of `new_from_timestamp()`

[etc/awesome.git] / doc / tzinfo.md

diff --git a/doc/tzinfo.md b/doc/tzinfo.md
index d9891027b7ee1257a783eaa2d9f5569635ae92fc..78d04530bf722e9acd7cf187757a9f52060e8121 100644 (file)
--- a/doc/tzinfo.md
+++ b/doc/tzinfo.md
@@ -13,7 +13,10 @@ so the following details can be skipped over.
 
 The table contains a sequence of tables that describe the timezone at a given point
 using a `transition_time`: the unix timestamp (in UTC) that this definition starts, and
-a `info` table, which contains information about the change at that point:
+a `tt_info` object.
+
+A `tt_info` object contains information about a time offset;
+and contains the following fields:
 
   - `gmtoff` (number) The offset from GMT (UTC) in seconds
   - `isdst` (boolean): If this change was declared as daylight savings
@@ -22,12 +25,13 @@ a `info` table, which contains information about the change at that point:
   - `isstd` (boolean)
   - `isgmt` (boolean)
 
+
 ## `:find_current ( utc_ts )`
 
-Returns the relevant `info` table at the given utc timestamp for the given UTC timestamp.
+Returns the relevant `tt_info` object for the given UTC timestamp in the timezone.
 
 
-## `:localize ( utc_ts )`
+## `:localise ( utc_ts )` and `:localize ( utc_ts )`
 
 Convert the given UTC timestamp to the timezone.
 Returns the number of seconds since unix epoch in the given timezone.