X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/73dc35e2f5590c00b7e6ca3ad6a473f8f992e5f9..31acfe7a5fe499c1698ae23ada97519b4b262469:/doc/parse.md?ds=sidebyside

diff --git a/doc/parse.md b/doc/parse.md
index 6d72fdf..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