Class: ActiveRecordDoctor::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record_doctor/help.rb

Overview

Turn a detector class into a human-readable help text.

Instance Method Summary collapse

Constructor Details

#initialize(klass) ⇒ Help

Returns a new instance of Help.



6
7
8
# File 'lib/active_record_doctor/help.rb', line 6

def initialize(klass)
  @klass = klass
end

Instance Method Details

#to_sObject



10
11
12
13
14
15
16
17
# File 'lib/active_record_doctor/help.rb', line 10

def to_s
  "\#{klass.underscored_name} - \#{klass.description}\n\nConfiguration options:\n\#{config_to_s}\n"
end