From 3bfdafcf4cf2ac07434836d6344baf3e67fb31a2 Mon Sep 17 00:00:00 2001
From: Hisham Muhammad <hisham@gobolinux.org>
Date: Wed, 29 Jan 2014 20:33:43 -0200
Subject: Fix documentation for setmode. Closes #32.

---
 doc/us/manual.html | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/us/manual.html b/doc/us/manual.html
index 3c5728e..80170de 100644
--- a/doc/us/manual.html
+++ b/doc/us/manual.html
@@ -227,8 +227,10 @@ LuaFileSystem offers the following functions:
     in case of error, it returns <code>nil</code> plus an error string.</dd>
 
     <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt>
-    <dd>Sets the writing mode for a file. The mode string can be either <code>binary</code> or <code>text</code>.
-    Returns the previous mode string for the file. On non-Windows platforms, where the two modes are identical,
+    <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>.
+    Returns <code>true</code> followed the previous mode string for the file, or
+    <code>nil</code> followed by an error string in case of errors.
+    On non-Windows platforms, where the two modes are identical,
     setting the mode has no effect, and the mode is always returned as <code>binary</code>.
     </dd>
     
-- 
cgit v1.2.3-55-g6feb