lihao/luafilesystem
1
0
Fork 0
mirror of https://github.com/lunarmodules/luafilesystem.git synced 2026-07-24 20:33:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for new return values

Browse Source
This commit is contained in:
Peter Melnichenko
2016-05-04 15:49:56 +03:00
parent 8d5f9661e9
commit 81e5b165bf
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/us/manual.html
View File

@@ -104,7 +104,7 @@ LuaFileSystem offers the following functions:
<dl class="reference"> <dl class="reference">
<dt><a name="attributes"></a><strong><code>lfs.attributes (filepath [, aname | atable])</code></strong></dt> <dt><a name="attributes"></a><strong><code>lfs.attributes (filepath [, aname | atable])</code></strong></dt>
<dd>Returns a table with the file attributes corresponding to <dd>Returns a table with the file attributes corresponding to
<code>filepath</code> (or <code>nil</code> followed by an error message <code>filepath</code> (or <code>nil</code> followed by an error message and a system-dependent error code
in case of error). in case of error).
If the second optional argument is given and is a string, then only the value of the If the second optional argument is given and is a string, then only the value of the
named attribute is returned (this use is equivalent to named attribute is returned (this use is equivalent to
@@ -222,14 +222,14 @@ LuaFileSystem offers the following functions:
<dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt> <dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt>
<dd>Creates a new directory. The argument is the name of the new <dd>Creates a new directory. The argument is the name of the new
directory.<br /> directory.<br />
Returns <code>true</code> if the operation was successful; Returns <code>true</code> in case of success or <code>nil</code>, an error message and
in case of error, it returns <code>nil</code> plus an error string. a system-dependent error code in case of error.
</dd> </dd>
<dt><a name="rmdir"></a><strong><code>lfs.rmdir (dirname)</code></strong></dt> <dt><a name="rmdir"></a><strong><code>lfs.rmdir (dirname)</code></strong></dt>
<dd>Removes an existing directory. The argument is the name of the directory.<br /> <dd>Removes an existing directory. The argument is the name of the directory.<br />
Returns <code>true</code> if the operation was successful; Returns <code>true</code> in case of success or <code>nil</code>, an error message and
in case of error, it returns <code>nil</code> plus an error string.</dd> a system-dependent error code in case of error.
<dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt> <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>. <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>.
@@ -255,8 +255,8 @@ LuaFileSystem offers the following functions:
Lua standard function <code>os.time</code>). Lua standard function <code>os.time</code>).
If the modification time is omitted, the access time provided is used; If the modification time is omitted, the access time provided is used;
if both times are omitted, the current time is used.<br /> if both times are omitted, the current time is used.<br />
Returns <code>true</code> if the operation was successful; Returns <code>true</code> in case of success or <code>nil</code>, an error message and
in case of error, it returns <code>nil</code> plus an error string. a system-dependent error code in case of error.
</dd> </dd>
<dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt> <dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt>