add error class docstrings

This commit is contained in:
2023-08-29 15:45:42 +01:00
parent 7cf05fbe08
commit 7c20063866
2 changed files with 5 additions and 2 deletions

View File

@@ -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