Update doc

This commit is contained in:
Michael Miller 2019-01-28 15:47:01 -07:00
parent 61a3e6b113
commit 69ffaa3796

View file

@ -2,9 +2,8 @@ require "./expectation"
module Spectator::Expectations module Spectator::Expectations
# Expectation that operates on values. # Expectation that operates on values.
# There are two values - the actual and expected. # There is a primary "actual" value that the SUT produced.
# The actual value is what the SUT returned. # A matcher is used on that value to determine whether it satisfies some criteria.
# The expected value is what the test wants to see.
class ValueExpectation(ActualType) < Expectation class ValueExpectation(ActualType) < Expectation
# Creates the expectation. # Creates the expectation.
# The `matched` flag should be true if the matcher is satisfied with the partial. # The `matched` flag should be true if the matcher is satisfied with the partial.