]> git.madduck.net Git - etc/awesome.git/blobdiff - doc/tzinfo.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

luatz/tzinfo: Fix accidental global
[etc/awesome.git] / doc / tzinfo.md
index 7ae1b55b6addc3b999b67ef6a31ff02cbd3daea5..78d04530bf722e9acd7cf187757a9f52060e8121 100644 (file)
@@ -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
 
 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
 
   - `gmtoff` (number) The offset from GMT (UTC) in seconds
   - `isdst` (boolean): If this change was declared as daylight savings
@@ -22,9 +25,10 @@ a `info` table, which contains information about the change at that point:
   - `isstd` (boolean)
   - `isgmt` (boolean)
 
   - `isstd` (boolean)
   - `isgmt` (boolean)
 
+
 ## `:find_current ( utc_ts )`
 
 ## `: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.
 
 
 ## `:localise ( utc_ts )` and `:localize ( utc_ts )`
 
 
 ## `:localise ( utc_ts )` and `:localize ( utc_ts )`