aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport
diff options
context:
space:
mode:
authorBogdan <bogdanvlviv@gmail.com>2018-12-17 10:25:55 +0200
committerRyuta Kamizono <kamipo@gmail.com>2018-12-17 17:25:55 +0900
commitfdb27193087c23ea2e7a0e8f6f035c47f274dbf7 (patch)
tree8c085967f00043ae143ec9f39414501830240925 /activesupport
parentce48b5a366482d4b4c4c053e1e39e79d71987197 (diff)
downloadrails-fdb27193087c23ea2e7a0e8f6f035c47f274dbf7.tar.gz
rails-fdb27193087c23ea2e7a0e8f6f035c47f274dbf7.tar.bz2
rails-fdb27193087c23ea2e7a0e8f6f035c47f274dbf7.zip
Extend documentation of `ActiveSupport::Notifications.subscribe` (#34721)
* Extend documentation of `ActiveSupport::Notifications.subscribe` Add mention that a block with only one argument passed to the method will yield an event object. Related to #33451 * Emphasize that `SubscribeEventObjects` is a test class by adding suffix `Test`
Diffstat (limited to 'activesupport')
-rw-r--r--activesupport/lib/active_support/notifications.rb9
-rw-r--r--activesupport/test/notifications_test.rb2
2 files changed, 9 insertions, 2 deletions
diff --git a/activesupport/lib/active_support/notifications.rb b/activesupport/lib/active_support/notifications.rb
index 01cc363e2b..0ff32bd810 100644
--- a/activesupport/lib/active_support/notifications.rb
+++ b/activesupport/lib/active_support/notifications.rb
@@ -177,7 +177,7 @@ module ActiveSupport
# names, or by passing a Regexp to match all events that match a pattern.
#
# ActiveSupport::Notifications.subscribe(/render/) do |*args|
- # ...
+ # @event = ActiveSupport::Notifications::Event.new(*args)
# end
#
# The +block+ will receive five parameters with information about the event:
@@ -189,6 +189,13 @@ module ActiveSupport
# id # => String, unique ID for the instrumenter that fired the event
# payload # => Hash, the payload
# end
+ #
+ # If the block passed to the method only takes one parameter,
+ # it will yield an event object to the block:
+ #
+ # ActiveSupport::Notifications.subscribe(/render/) do |event|
+ # @event = event
+ # end
def subscribe(*args, &block)
notifier.subscribe(*args, &block)
end
diff --git a/activesupport/test/notifications_test.rb b/activesupport/test/notifications_test.rb
index 54fd4345fb..4e0aef2cc7 100644
--- a/activesupport/test/notifications_test.rb
+++ b/activesupport/test/notifications_test.rb
@@ -26,7 +26,7 @@ module Notifications
end
end
- class SubscribeEventObjects < TestCase
+ class SubscribeEventObjectsTest < TestCase
def test_subscribe_events
events = []
@notifier.subscribe do |event|