DidYouMean::Formatter.message_for

(::Array[::String] corrections) -> ::String

message_for(corrections)

lib/did_you_mean/formatter.rb View on GitHub ↗

# File tmp/rubies/ruby-3.4.1/lib/did_you_mean/formatter.rb, line 29
def self.message_for(corrections)
  corrections.empty? ? "" : "\nDid you mean?  #{corrections.join("\n               ")}"
end

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

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

See also #message_for also in 4.1 · 4.0 · 3.3 · 3.2 · 3.1

next ›#message_for