Class: Inch::Evaluation::Role::Object::WithoutDoc

Inherits:
Missing
  • Object
show all
Defined in:
lib/inch/evaluation/role/object.rb

Overview

Role assigned to objects without a docstring

Direct Known Subclasses

Constant::WithoutDoc

Instance Attribute Summary

Attributes inherited from Base

#object

Instance Method Summary collapse

Methods inherited from Missing

#potential_score, #score

Methods inherited from Base

applicable?, applicable_if, applicable_unless, #initialize, #max_score, #min_score, #object_type, #potential_score, #priority, #score

Constructor Details

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

Instance Method Details

#suggestion ⇒ Object 



27
28
29
 
# File 'lib/inch/evaluation/role/object.rb', line 27

def suggestion
  "Add a comment describing the #{object_type}"
end