class DidYouMean::Formatter

The DidYouMean::Formatter is the basic, default formatter for the gem. The formatter responds to the message_for method and it returns a human readable string.

Public Class Methods

message_for

(Array[String] corrections) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/did_you_mean/0/did_you_mean.rbs, line 124
def self.message_for: (Array[String] corrections) -> String

Returns a human readable string that contains corrections. This formatter is designed to be less verbose to not take too much screen space while being helpful enough to the user.

@example

formatter = DidYouMean::Formatter.new

# displays suggestions in two lines with the leading empty line
puts formatter.message_for(["methods", "method"])

Did you mean?  methods
                method
# => nil

# displays an empty line
puts formatter.message_for([])

# => nil