Refactor to add top-level class documentation for error classes

Author: Sebastian Wilgosz

lib/jsonapi_errors_handler/errors/forbidden.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of forbidden HTTP error (403 status code)
+    #
     class Forbidden < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(

lib/jsonapi_errors_handler/errors/invalid.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of invalid HTTP error (422 status code)
+    #
     class Invalid < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(errors: {})
         @errors = errors

lib/jsonapi_errors_handler/errors/not_found.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of NotFound HTTP error (404 status code)
+    #
     class NotFound < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(

lib/jsonapi_errors_handler/errors/standard_error.rb

@@ -4,8 +4,13 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of Unexpected HTTP error (500 status code)
+    # It's also a fallback for not mapped errors in the application.
+    #
     class StandardError < ::StandardError
-      def initialize(title: nil, status: nil, detail: nil, message: nil, source: {})
+      def initialize(
+        title: nil, status: nil, detail: nil, message: nil, source: {}
+      )
         @title = title || 'Something went wrong'
         @detail = detail || message
         @detail ||= "We've encountered unexpected error, but our developers had been already notified about it" # rubocop:disable Metrics/LineLength

lib/jsonapi_errors_handler/errors/unauthorized.rb

@@ -2,6 +2,8 @@
 
 module JsonapiErrorsHandler
   module Errors
+    # Handles serialization of Unauthorized HTTP error (401 status code)
+    #
     class Unauthorized < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(