Class: YardExampleTest::Expectation

Inherits:

Data

• Object
• Data
• YardExampleTest::Expectation

Defined in:

lib/yard_example_test/expectation.rb,
lib/yard_example_test/expectation.rb

Overview

Represents a single expected outcome parsed from a YARD +@example+ tag

Each instance holds the Ruby expression to evaluate (+actual+) and the string representation of the value it should return (+expected+). When +expected+ is +nil+, the expression is evaluated for side-effects only and no assertion is made against its return value.

Instance Attribute Summary

• #actual ⇒ String readonly

  the Ruby expression to evaluate.

• #expected ⇒ Object readonly

  Returns the value of attribute expected.

Instance Attribute Details

#actual ⇒ String (readonly)

the Ruby expression to evaluate

Examples:

blah

# File 'lib/yard_example_test/expectation.rb', line 22

class Expectation < Data; end

#expected ⇒ Object (readonly)

Returns the value of attribute expected

# File 'lib/yard_example_test/expectation.rb', line 22

class Expectation < Data; end