From a65f285d5f3a725bc5d0d99c5cfe3a85b81d1ec8 Mon Sep 17 00:00:00 2001
From: Tom de Bruijn <tom@tomdebruijn.com>
Date: Mon, 5 Aug 2024 13:18:52 +0200
Subject: [PATCH] Document listen_for_error deprecation in API docs

Make sure it's documented in the API docs as deprecated as well. In case
we do another release before 4.0, this can be included.

[skip changeset]
---
 lib/appsignal/helpers/instrumentation.rb | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lib/appsignal/helpers/instrumentation.rb b/lib/appsignal/helpers/instrumentation.rb
index 2bff8d9ab..7408d4342 100644
--- a/lib/appsignal/helpers/instrumentation.rb
+++ b/lib/appsignal/helpers/instrumentation.rb
@@ -300,7 +300,10 @@ def monitor_single_transaction(name, env = {}, &block)
       # @see .send_error
       # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
       #   AppSignal integration guide
+      # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
+      #   Exception handling guide
       #
+      # @deprecated Use `rescue => error` with {.report_error} instead.
       # @param tags [Hash, nil]
       # @param namespace [String] the namespace for this error.
       # @yield yields the given block.