aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/notifications.rb
diff options
context:
space:
mode:
authorGannon McGibbon <gannon.mcgibbon@gmail.com>2018-12-31 15:11:53 -0500
committerGitHub <noreply@github.com>2018-12-31 15:11:53 -0500
commit710e0ffc5a77b338da0a1a0e21d97b514315e1f6 (patch)
treef6984bbd8df5f005f647b38db12d3aaf2120cb64 /activesupport/lib/active_support/notifications.rb
parent651f5819bb8f3110e6cc1cd9c23f81a09ed77f10 (diff)
parent2701a18d387f8187579d7a45a503ec838952bd47 (diff)
downloadrails-710e0ffc5a77b338da0a1a0e21d97b514315e1f6.tar.gz
rails-710e0ffc5a77b338da0a1a0e21d97b514315e1f6.tar.bz2
rails-710e0ffc5a77b338da0a1a0e21d97b514315e1f6.zip
Merge pull request #34707 from xlts/update-notifications-docs
Add examples describing error handling in ActiveSupport::Notification…
Diffstat (limited to 'activesupport/lib/active_support/notifications.rb')
-rw-r--r--activesupport/lib/active_support/notifications.rb7
1 files changed, 5 insertions, 2 deletions
diff --git a/activesupport/lib/active_support/notifications.rb b/activesupport/lib/active_support/notifications.rb
index 0ff32bd810..7ccc333463 100644
--- a/activesupport/lib/active_support/notifications.rb
+++ b/activesupport/lib/active_support/notifications.rb
@@ -67,9 +67,12 @@ module ActiveSupport
# have a key <tt>:exception</tt> with an array of two elements as value: a string with
# the name of the exception class, and the exception message.
# The <tt>:exception_object</tt> key of the payload will have the exception
- # itself as the value.
+ # itself as the value:
#
- # As the previous example depicts, the class <tt>ActiveSupport::Notifications::Event</tt>
+ # event.payload[:exception] # => ["ArgumentError", "Invalid value"]
+ # event.payload[:exception_object] # => #<ArgumentError: Invalid value>
+ #
+ # As the earlier example depicts, the class <tt>ActiveSupport::Notifications::Event</tt>
# is able to take the arguments as they come and provide an object-oriented
# interface to that data.
#