README.md: Add coveralls badge

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

diff --git a/doc/parse.md b/doc/parse.md
index 993bead0fadbbb64dfe3197647fbddc46f154ff6..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 postition.
+Functions take the source string and an optional initial postition.
 
-## `rfc_3339`
+### `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