X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/8f5786554f58cae293237590d9fe918158b61561..30a82a3ecf764b2349cde9755686b1109ebe4b2a:/doc/parse.md diff --git a/doc/parse.md b/doc/parse.md index 39529dd..c41eae5 100644 --- a/doc/parse.md +++ b/doc/parse.md @@ -1,9 +1,12 @@ -# `luatz.parse` +## `luatz.parse` {#parse} Provides parsers for common time and date formats. Functions take the source string and an optional initial postition. -### `rfc_3339 ( string [, init] )` +### `rfc_3339(string[, init])` {#parse.rfc_3339} -Returns a luatz timetable and the (optional) time zone offset in seconds +If the string is a valid RFC-3339 timestamp, +returns a luatz timetable and the (optional) time zone offset in seconds. + +Otherwise returns `nil` and an error message