README: Add header

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

diff --git a/doc/parse.md b/doc/parse.md
index 39529dd1308b50350e7ebe53523c343217c0b346..c41eae56ae11ef629b7e841e5364924f63bd7b37 100644 (file)
--- 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.
 
 
 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