Skip to content
Browse files

More doc tweaks

  • Loading branch information...
1 parent a25b0da commit 491e51c74adcf926ae3c52f4f2206f4cee8933fe @obrie obrie committed Mar 4, 2009
Showing with 6 additions and 6 deletions.
  1. +1 −1 lib/state_machine/guard.rb
  2. +4 −4 lib/state_machine/machine.rb
  3. +1 −1 lib/state_machine/transition.rb
View
2 lib/state_machine/guard.rb
@@ -180,7 +180,7 @@ def build_matcher(options, whitelist_option, blacklist_option)
end
# Verifies that all configured requirements (event and state) match the
- # given query. If a match is return, then a hash containing the
+ # given query. If a match is found, then a hash containing the
# event/state requirements that passed will be returned; otherwise, nil.
def match_query(query)
query ||= {}
View
8 lib/state_machine/machine.rb
@@ -44,7 +44,7 @@ module StateMachine
# example,
#
# class Vehicle
- # state_machine, :initial => :parked do
+ # state_machine :initial => :parked do
# before_transition any => :idling, :do => lambda {|vehicle| throw :halt}
# ...
# end
@@ -454,7 +454,7 @@ def initial_state(object)
#
# == Behaviors
#
- # Behaviors defined a series of methods to mixin with objects when the current
+ # Behaviors define a series of methods to mixin with objects when the current
# state matches the given one(s). This allows instance methods to behave
# a specific way depending on what the value of the object's state is.
#
@@ -569,7 +569,7 @@ def initial_state(object)
# This functionality is not library-specific and can work for any class-level
# method that is defined like so:
#
- # def validates_presence_of(args, options = {})
+ # def validates_presence_of(attribute, options = {})
# ...
# end
#
@@ -597,7 +597,7 @@ def state(*names, &block)
# Determines whether the given object is in a specific state. If the
# object's current value doesn't match the state, then this will return
# false, otherwise true. If the given state is unknown, then an ArgumentError
- # exception will be raised.
+ # will be raised.
#
# == Examples
#
View
2 lib/state_machine/transition.rb
@@ -16,7 +16,7 @@ class Transition
# The state machine for which this transition is defined
attr_reader :machine
- # The event that caused the transition
+ # The event that triggered the transition
attr_reader :event
# The original state value *before* the transition

0 comments on commit 491e51c

Please sign in to comment.
Something went wrong with that request. Please try again.