Permalink
Browse files

Clarify docs a bit.

  • Loading branch information...
1 parent 0ba1f39 commit 401646ceed12425dfc6a673e7478235639575ad6 @myronmarston myronmarston committed Jul 23, 2014
Showing with 5 additions and 4 deletions.
  1. +1 −0 lib/rspec/expectations/configuration.rb
  2. +4 −4 lib/rspec/matchers/dsl.rb
@@ -109,6 +109,7 @@ def backtrace_formatter
# Sets if custom matcher descriptions and failure messages
# should include clauses from methods defined using `chain`.
+ # @param value [Boolean]
attr_writer :include_chain_clauses_in_custom_matcher_descriptions
# Indicates whether or not custom matcher descriptions and failure messages
@@ -160,10 +160,10 @@ def supports_block_expectations
# Convenience for defining methods on this matcher to create a fluent
# interface. The trick about fluent interfaces is that each method must
# return self in order to chain methods together. `chain` handles that
- # for you. If the expectation is used, and
- # RSpec::Expectations.configuration.include_chain_clauses_in_custom_matcher_descriptions
- # is true, it also adds the chained expectation's clause to the
- # default description.
+ # for you. If the method is invoked and the
+ # `include_chain_clauses_in_custom_matcher_descriptions` config option
+ # hash been enabled, the chained method name and args will be added to the
+ # default description and failure message.
#
# @example
#

0 comments on commit 401646c

Please sign in to comment.