Fix luacheck warnings

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

diff --git a/doc/index.md b/doc/index.md
index 6c08c2462b690a709d0c5abbddef5e99427395ba..68a3381eede51ca49d3cb3e3dd0c729fde01c4d9 100644 (file)
--- a/doc/index.md
+++ b/doc/index.md
@@ -1,26 +1,51 @@
-# `luatz`
+## `luatz`

 
 Requiring the base luatz module will give you a table of commonly used functions and submodules.
 
 The table includes the following sub modules, which have their own documentation:
 
 
 Requiring the base luatz module will give you a table of commonly used functions and submodules.
 
 The table includes the following sub modules, which have their own documentation:
 

-  - `parse`: Parses common date/time formats
-  - `timetable`: Class for date/time objects supporting normalisation
+  - [`parse`](#parse): Parses common date/time formats
+  - [`timetable`](#timetable): Class for date/time objects supporting normalisation

 
 

+### `time()` <!-- --> {#luatz.time}

 
 

-## `time ( )`
+Returns the current unix timestamp using the most precise source available.
+See [`gettime`](#luatz.gettime) for more information.

 
 

-Returns the current unix timestamp using the most accurate source available.
-See `gettime` for more information.

 
 

+### `now()` <!-- --> {#luatz.now}

 
 

-## `get_tz ( timezone_name )`
+Returns the current time as a timetable object
+See `timetable` for more information
+
+
+### `get_tz([timezone_name])` <!-- --> {#luatz.get_tz}

 
 Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`.
 
 Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`.

-This uses the local zoneinfo database; names are usually of the form `Country/Largest_City`.
+If `timezone_name` is `nil` then the local timezone is used.
+If `timezone_name` is an absolute path, then that `tzinfo` file is used
+
+This uses the local [zoneinfo database](https://www.iana.org/time-zones); 
+names are usually of the form `Country/Largest_City` e.g. "America/New_York".
+Check [wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for an example list.
+
+
+### `time_in(timezone_name[, utc_ts])` <!-- --> {#luatz.time_in}
+
+Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone as a string,
+(same semantics as [`get_tz`](#luatz.get_tz)) at the given UTC time (defaults to now).
+
+
+### `gmtime(ts)` <!-- --> {#luatz.gmtime}
+
+As in the C standard library
+
+
+### `localtime(ts)` <!-- --> {#luatz.localtime}
+
+As in the C standard library

 
 
 
 

-## `time_in ( timezone_name [, utc_ts] )`
+### `ctime(ts)` <!-- --> {#luatz.ctime}

 
 

-Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone
-(as a string, e.g. "America/New_York") at the given UTC time (defaults to now).
+As in the C standard library