Skip to content

Commit 24edd7a

Browse files
committed
Add docstrings to FileSystem async interface
1 parent 30a6c3f commit 24edd7a

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

BlocksScreen/devices/storage/udisks2_dbus_async.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,18 +201,45 @@ def __init__(self) -> None:
201201

202202
@sdbus.dbus_method_async(input_signature="a{sv}", result_signature="s")
203203
async def mount(self, opts) -> str:
204+
"""Mounts the filesystem
205+
206+
Args:
207+
options dict[str, tuple[str, any]]: Options to mount the filesystem
208+
209+
Returns:
210+
path (str): mount path
211+
"""
204212
raise NotImplementedError
205213

206214
@sdbus.dbus_method_async(input_signature="a{sv}")
207215
async def unmount(self, opts) -> None:
216+
"""Unmount a mounted device
217+
218+
Args:
219+
options dict[str, any]: Known options (in addition to the standart options) include `force` (of type `b`)
220+
"""
208221
raise NotImplementedError
209222

210223
@sdbus.dbus_property_async(property_signature="t")
211224
def size(self) -> int:
225+
"""Size of the filesystem. This is the amount
226+
of bytes used on the block device representing an outer
227+
fileysstem boundary
228+
229+
Returns:
230+
size (int): Size of the filesystem
231+
"""
212232
raise NotImplementedError
213233

214234
@sdbus.dbus_property_async(property_signature="ayy")
215235
def mount_points(self) -> list[bytes]:
236+
"""An array of filesystem paths for where the
237+
file system on the device is mounted. If the
238+
device is not mounted, this array will be empty
239+
240+
Returns
241+
mount_points (list[bytes]): Array of filesystem paths
242+
"""
216243
raise NotImplementedError
217244

218245

0 commit comments

Comments
 (0)