From 7c20063866163e3f5c0a0b4185abbcbb565cd76b Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Tue, 29 Aug 2023 15:45:42 +0100
Subject: [PATCH] add error class docstrings

---
 lib/obsws.rb       | 3 +++
 lib/obsws/mixin.rb | 4 ++--
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/lib/obsws.rb b/lib/obsws.rb
index 7560261..2ea3a21 100644
--- a/lib/obsws.rb
+++ b/lib/obsws.rb
@@ -18,10 +18,13 @@ require_relative "obsws/event"
 require_relative "obsws/version"
 
 module OBSWS
+  # Base OBSWS error class
   class OBSWSError < StandardError; end
 
+  # Raised when a connection fails or times out
   class OBSWSConnectionError < OBSWSError; end
 
+  # Raised when a request returns an error code
   class OBSWSRequestError < OBSWSError
     attr_reader :req_name, :code
 
diff --git a/lib/obsws/mixin.rb b/lib/obsws/mixin.rb
index 70f43c0..d26bf58 100644
--- a/lib/obsws/mixin.rb
+++ b/lib/obsws/mixin.rb
@@ -24,11 +24,11 @@ module OBSWS
       def attrs = @fields.map { |f| snakecase(f.to_s) }
     end
 
-    class Response < MetaObject; end
     # Represents a request response object
+    class Response < MetaObject; end
 
-    class Data < MetaObject; end
     # Represents an event data object
+    class Data < MetaObject; end
 
     module TearDown
       def stop_driver