From 4f087a035875b709e8259054bfa3fa4aaf9a6749 Mon Sep 17 00:00:00 2001
From: Onyx and Iris <75868496+onyx-and-iris@users.noreply.github.com>
Date: Fri, 2 Jan 2026 20:51:50 +0000
Subject: [PATCH] upd docstrings

---
 duckypad_twitch/util.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/duckypad_twitch/util.py b/duckypad_twitch/util.py
index 5523945..f35988e 100644
--- a/duckypad_twitch/util.py
+++ b/duckypad_twitch/util.py
@@ -1,5 +1,7 @@
 def ensure_obsws(func):
-    """ensure an obs websocket connection has been established"""
+    """ensure an obs websocket connection has been established
+
+    Used as a decorator for functions that require an obs websocket connection"""
 
     def wrapper(self, *args):
         if self.request is None:
@@ -11,8 +13,11 @@ def ensure_obsws(func):
 
     return wrapper
 
+
 def ensure_mixer_fadeout(func):
-    """ensure mixer fadeout is stopped before proceeding"""
+    """ensure mixer is faded out before proceeding (disable monitor speaker)
+
+    Used as a decorator for functions that require the mixer to be faded out"""
 
     def wrapper(self, *args):
         if self.mixer.lr.mix.fader > -90:
@@ -21,6 +26,7 @@ def ensure_mixer_fadeout(func):
 
     return wrapper
 
+
 def to_snakecase(scene_name: str) -> str:
     """Convert caplitalized words to lowercase snake_case"""
     return '_'.join(word.lower() for word in scene_name.split())