Class: Inch::Evaluation::Role::Missing

Inherits:

Base

• Object
• Base
• Inch::Evaluation::Role::Missing

Defined in:

lib/inch/evaluation/role/missing.rb

Overview

Missing is the base class for things that can be improved in the doc

Direct Known Subclasses

Inch::Evaluation::Role::Method::WithoutReturnDescription, Inch::Evaluation::Role::Method::WithoutReturnType, Inch::Evaluation::Role::MethodParameter::WithoutMention, Inch::Evaluation::Role::MethodParameter::WithoutType, Object::WithoutCodeExample, Object::WithoutDoc

Instance Attribute Summary

Attributes inherited from Base

#object

Instance Method Summary

• #potential_score ⇒ Fixnum

  A score that can be achieved by adding the missing thing mentioned by the role.

• #score ⇒ Object

Methods inherited from Base

applicable?, applicable_if, applicable_unless, #initialize, #max_score, #min_score, #object_type, #priority, #suggestion

Constructor Details

This class inherits a constructor from Inch::Evaluation::Role::Base

Instance Method Details

#potential_score ⇒ Fixnum

Returns a score that can be achieved by adding the missing thing mentioned by the role.

Returns:

• (Fixnum) —

  a score that can be achieved by adding the missing thing mentioned by the role

# File 'lib/inch/evaluation/role/missing.rb', line 14

def potential_score
  @value.to_i
end

#score ⇒ Object

# File 'lib/inch/evaluation/role/missing.rb', line 7

def score
  nil
end