lib/rspec/expectations/syntax.rb in rspec-expectations-3.7.0 vs lib/rspec/expectations/syntax.rb in rspec-expectations-3.8.0
- old
+ new
@@ -104,11 +104,11 @@
# The legacy `:should` syntax adds the following methods directly to
# `BasicObject` so that they are available off of any object. Note, however,
# that this syntax does not always play nice with delegate/proxy objects.
# We recommend you use the non-monkeypatching `:expect` syntax instead.
class BasicObject
- # @method should
+ # @method should(matcher, message)
# Passes if `matcher` returns true. Available on every `Object`.
# @example
# actual.should eq expected
# actual.should match /expression/
# @param [Matcher]
@@ -116,10 +116,10 @@
# @param [String] message optional message to display when the expectation fails
# @return [Boolean] true if the expectation succeeds (else raises)
# @note This is only available when you have enabled the `:should` syntax.
# @see RSpec::Matchers
- # @method should_not
+ # @method should_not(matcher, message)
# Passes if `matcher` returns false. Available on every `Object`.
# @example
# actual.should_not eq expected
# @param [Matcher]
# matcher