onyx_online/obsws-ruby
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-ruby.git synced 2024-11-15 18:50:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

add error class docstrings

Browse Source
This commit is contained in:
onyx-and-iris 2023-08-29 15:45:42 +01:00
parent 7cf05fbe08
commit 7c20063866
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/obsws.rb
View File

@ -18,10 +18,13 @@ require_relative "obsws/event"
require_relative "obsws/version" require_relative "obsws/version"
module OBSWS module OBSWS
# Base OBSWS error class
class OBSWSError < StandardError; end class OBSWSError < StandardError; end
# Raised when a connection fails or times out
class OBSWSConnectionError < OBSWSError; end class OBSWSConnectionError < OBSWSError; end
# Raised when a request returns an error code
class OBSWSRequestError < OBSWSError class OBSWSRequestError < OBSWSError
attr_reader :req_name, :code attr_reader :req_name, :code

4
lib/obsws/mixin.rb
View File

@ -24,11 +24,11 @@ module OBSWS
def attrs = @fields.map { |f| snakecase(f.to_s) } def attrs = @fields.map { |f| snakecase(f.to_s) }
end end
class Response < MetaObject; end
# Represents a request response object # Represents a request response object
class Response < MetaObject; end
class Data < MetaObject; end
# Represents an event data object # Represents an event data object
class Data < MetaObject; end
module TearDown module TearDown
def stop_driver def stop_driver