lib/hallon/error.rb in hallon-0.8.0 vs lib/hallon/error.rb in hallon-0.9.0

@@ -33,9 +33,12 @@
         end
       end
 
       # Explain a Spotify error with a string message.
       #
+      # @example
+      #   Hallon::Error.explain(:ok) # => "No error"
+      #
       # @param [Fixnum, Symbol]
       # @return [String]
       def explain(error)
         Spotify.error_message disambiguate(error)[0]
       end