Fix documentation for setmode. Closes #32.

This commit is contained in:
Hisham Muhammad
2014-01-29 20:33:43 -02:00
parent 00b17c6f1a
commit 3bfdafcf4c

View File

@@ -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>