summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorAnson Mansfield <amansfield@mantaro.com>2025-03-03 14:25:14 -0500
committerDamien George <damien@micropython.org>2025-03-27 16:37:04 +1100
commitc68a40ac94ea8a8dd6031dff6f21706977893bef (patch)
tree15677b362bf857a0472b42bfa18c20ea8df40082 /docs/library
parent9fcc25b9d7e6246f9c1dda3c07f3e718f751e74c (diff)
docs/library/vfs: Document no-args mount output.
Signed-off-by: Anson Mansfield <amansfield@mantaro.com>
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/vfs.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/library/vfs.rst b/docs/library/vfs.rst
index fcd06eb43..1fa1e3060 100644
--- a/docs/library/vfs.rst
+++ b/docs/library/vfs.rst
@@ -34,6 +34,14 @@ represented by VFS classes.
Will raise ``OSError(EPERM)`` if *mount_point* is already mounted.
+.. function:: mount()
+ :noindex:
+
+ With no arguments to :func:`mount`, return a list of tuples representing
+ all active mountpoints.
+
+ The returned list has the form *[(fsobj, mount_point), ...]*.
+
.. function:: umount(mount_point)
Unmount a filesystem. *mount_point* can be a string naming the mount location,