Class: Inch::Language::Nodejs::Evaluation::Role::Object::WithoutDoc

Inherits:

Missing

• Object
• Evaluation::Role
• Base
• Missing
• Inch::Language::Nodejs::Evaluation::Role::Object::WithoutDoc

Defined in:

lib/inch/language/nodejs/roles/object.rb

Overview

Role assigned to objects without a docstring

Instance Attribute Summary

Attributes inherited from Evaluation::Role

#object

Instance Method Summary

• #suggestion ⇒ Object

Methods inherited from Missing

#potential_score, #score

Methods inherited from Base

#object_type

Methods inherited from Evaluation::Role

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

Constructor Details

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

Instance Method Details

#suggestion ⇒ Object

# File 'lib/inch/language/nodejs/roles/object.rb', line 17

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