Class: Yard::Lint::Validators::Documentation::UnderfilledLines::MessagesBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/lint/validators/documentation/underfilled_lines/messages_builder.rb

Overview

Builds human-readable messages for UnderfilledLines violations.

Class Method Summary collapse

Class Method Details

.call(offense) ⇒ String

Returns formatted message.

Parameters:

  • offense (Hash) —

    offense details with :actual_lines, :reflowed_lines, :widest_fill, :max_length and :object_name

Returns:

  • (String) —

    formatted message



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/yard/lint/validators/documentation/underfilled_lines/messages_builder.rb', line 14

def call(offense)
  actual = offense[:actual_lines]
  reflowed = offense[:reflowed_lines]
  widest = offense[:widest_fill]
  max_length = offense[:max_length]
  object_name = offense[:object_name]

  "Documentation paragraph uses #{actual} lines but fits in #{reflowed} " \
    "at <=#{max_length} cols [widest line filled to #{widest}/#{max_length}] " \
    "for '#{object_name}'"
end