Merge pull request #151 from Krakonos/masterv2.0.1

Fixed documentation for return lfs_dir_read return value.

1 files changed, 2 insertions, 1 deletions

diff --git a/lfs.h b/lfs.h
index ae991e0..c78b3d6 100644
--- a/lfs.h
+++ b/lfs.h
@@ -578,7 +578,8 @@ int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir);
 // Read an entry in the directory
 //
 // Fills out the info structure, based on the specified file or directory.
-// Returns a negative error code on failure.
+// Returns a positive value on success, 0 at the end of directory,
+// or a negative error code on failure.
 int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info);
 
 // Change the position of the directory