From 5d893fc963b4d4089551085155057ae960c1e085 Mon Sep 17 00:00:00 2001
From: uvok
Date: Thu, 23 Jan 2025 20:48:19 +0100
Subject: Add doc

---
 de_uvok/activitypub_fuse/fuse.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'de_uvok/activitypub_fuse/fuse.py')

diff --git a/de_uvok/activitypub_fuse/fuse.py b/de_uvok/activitypub_fuse/fuse.py
index 5a6052f..46eeb02 100644
--- a/de_uvok/activitypub_fuse/fuse.py
+++ b/de_uvok/activitypub_fuse/fuse.py
@@ -13,7 +13,14 @@ from .types import Status
 
 
 class StatusFileSystem(Operations, LoggingMixIn):
+    """
+    Implements a FUSE file system for mapping (ActivityPub, Mastodon, ...) statuses to text files.
+    """
+
     def __init__(self):
+        """
+        Initialize a new instance of StatusFileSystem, to be used with FUSE.
+        """
         self.__queue: SimpleQueue[list[Status]] = SimpleQueue()
         self.__statuses: list[Status] = []
         self.__fd = 0
@@ -44,6 +51,9 @@ class StatusFileSystem(Operations, LoggingMixIn):
         raise FuseOSError(errno.ENOENT)
 
     def __update_status_field(self):
+        """
+        Update the internal statuses list with new statuses from the queue.
+        """
         try:
             while True:
                 statuses = self.__queue.get_nowait()
@@ -64,6 +74,12 @@ class StatusFileSystem(Operations, LoggingMixIn):
         return dir_entries
 
     def add_statuses(self, statuses: list[Status]):
+        """
+        Add new statuses to the queue.
+
+        Args:
+            statuses (list): A list of Status objects to be added.
+        """
         self.__queue.put(statuses)
 
     def open(self, path, flags):  # type: ignore
-- 
cgit v1.2.3