Skip to content

Commit 7a15c97

Browse files
alectric-trdpgeorge
authored andcommitted
docs/library/os: Clarify ilistdir tuples size element.
The currently documentation for ilistdir tuples says that the size element is included based on the platform. However, this is not the case as it is included based on the filesystem type. This commit makes the according adjustment. Fixes issue micropython#17516. Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
1 parent 1284203 commit 7a15c97

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/library/os.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,9 @@ Filesystem access
5555
directories and 0x8000 for regular files;
5656
- *inode* is an integer corresponding to the inode of the file, and may be 0
5757
for filesystems that don't have such a notion.
58-
- Some platforms may return a 4-tuple that includes the entry's *size*. For
59-
file entries, *size* is an integer representing the size of the file
60-
or -1 if unknown. Its meaning is currently undefined for directory
61-
entries.
58+
- *size* is an integer that may be included depending on the filesystem type.
59+
For file entries, *size* represents the size of the file or -1 if unknown.
60+
Its meaning is currently undefined for directory entries.
6261

6362
.. function:: listdir([dir])
6463

0 commit comments

Comments
 (0)