mirror of
				https://github.com/onyx-and-iris/obsws-ruby.git
				synced 2025-11-04 02:01:45 +00:00 
			
		
		
		
	add error class docstrings
This commit is contained in:
		
							parent
							
								
									7cf05fbe08
								
							
						
					
					
						commit
						7c20063866
					
				@ -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
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user