Skip to content

Commit

Permalink
Improve docs a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
mattwynne committed May 21, 2016
1 parent 3f41ac4 commit 633cb14
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions lib/cucumber/events.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@ module Cucumber
# Events tell you what's happening while Cucumber runs your features.
#
# They're designed to be read-only, appropriate for writing formatters and other
# output tools. If you need to be able to influence the result of a scenario, use a hook instead.
# output tools. If you need to be able to influence the result of a scenario, use a {RbSupport::RbDsl hook} instead.
#
# To subscribe to an event, use {Cucumber::Configuration#on_event}
#
# @example
# AfterConfiguration do |config|
# config.on_event :after_test_step do |event|
# config.on_event :test_case_finished do |event|
# puts event.result
# end
# end
#
module Events
def self.registry
Core::Events.build_registry(
Expand Down

0 comments on commit 633cb14

Please sign in to comment.