Add missing documentation for Rails.error

The functionality itself is documented, but not the accessor
rails · Sep 2, 2022 · e4c237e · e4c237e
1 parent d96612d
commit e4c237e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/railties/lib/rails.rb b/railties/lib/rails.rb
@@ -80,6 +80,13 @@ def env=(environment)
       @_env = ActiveSupport::EnvironmentInquirer.new(environment)
     end
 
+    # Returns the ActiveSupport::ErrorReporter of the current Rails project,
+    # otherwise it returns +nil+ if there is no project.
+    #
+    #   Rails.error.handle(IOError) do
+    #     # ...
+    #   end
+    #   Rails.error.report(error)
     def error
       application && application.executor.error_reporter
     end