]> git.madduck.net Git - etc/awesome.git/blobdiff - doc/parse.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

spec/timetable_spec: Fix order of arguments to assert.same
[etc/awesome.git] / doc / parse.md
index 993bead0fadbbb64dfe3197647fbddc46f154ff6..649ee8121c8c56244ad1177893acba9c75dd6f9b 100644 (file)
@@ -2,8 +2,11 @@
 
 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] )`
 
-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