Class: Yardstick::RuleSet

Inherits:

OrderedSet

• Object
• OrderedSet
• Yardstick::RuleSet

Defined in:

lib/yardstick/rule_set.rb

Overview

A set of rules to apply to docs

Instance Method Summary

• #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

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

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