Class: Yardstick::RuleSet

Inherits:

Object
OrderedSet
Yardstick::RuleSet

Defined in:: lib/yardstick/rule_set.rb

Instance Method Summary collapse

#measure(docstring) ⇒ MeasurementSet private

Measure a docstring with all Rules.

Methods inherited from OrderedSet

#<<, #each, #empty?, #include?, #index, #initialize, #length, #merge

Constructor Details

This class inherits a constructor from Yardstick::OrderedSet

Instance Method Details

#measure(docstring) ⇒ `MeasurementSet`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Measure a docstring with all Rules

Parameters:

docstring (YARD::Docstring) —

the docstring to measure

Returns:

(MeasurementSet) —

a collection of measurements



13
14
15

# File 'lib/yardstick/rule_set.rb', line 13

def measure(docstring)
  MeasurementSet.new(map { |rule| rule.measure(docstring) })
end