lib/pwned/error.rb in pwned-1.1.0 vs lib/pwned/error.rb in pwned-1.2.0

@@ -1,9 +1,20 @@
 # frozen_string_literal: true
 
 module Pwned
+  ##
+  # A base error for HTTP request errors that may be thrown when making requests
+  # to the Pwned Passwords API.
+  #
+  # @see Pwned::Password#pwned?
+  # @see Pwned::Password#pwned_count
   class Error < StandardError
   end
 
+  ##
+  # An error to represent when the Pwned Passwords API times out.
+  #
+  # @see Pwned::Password#pwned?
+  # @see Pwned::Password#pwned_count
   class TimeoutError < Error
   end
 end