Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2025-12-16 09:50:15 +01:00
Code Issues Actions 27 Packages Projects Releases Wiki Activity

docs/library/os: Clarify ilistdir tuples size element.

Browse Source 
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 #17516.

Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
This commit is contained in:
Alex Tran
2025-11-18 21:43:55 -08:00
committed by Damien George
parent 128420359e
commit 7a15c97f06
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/library/os.rst
View File

@@ -55,10 +55,9 @@ Filesystem access
directories and 0x8000 for regular files; directories and 0x8000 for regular files;
- *inode* is an integer corresponding to the inode of the file, and may be 0 - *inode* is an integer corresponding to the inode of the file, and may be 0
for filesystems that don't have such a notion. for filesystems that don't have such a notion.
- Some platforms may return a 4-tuple that includes the entry's *size*. For - *size* is an integer that may be included depending on the filesystem type.
file entries, *size* is an integer representing the size of the file For file entries, *size* represents the size of the file or -1 if unknown.
or -1 if unknown. Its meaning is currently undefined for directory Its meaning is currently undefined for directory entries.
entries.
.. function:: listdir([dir]) .. function:: listdir([dir])