diff options
Diffstat (limited to 'lib/did_you_mean/formatters/plain_formatter.rb')
| -rw-r--r-- | lib/did_you_mean/formatters/plain_formatter.rb | 35 |
1 files changed, 3 insertions, 32 deletions
diff --git a/lib/did_you_mean/formatters/plain_formatter.rb b/lib/did_you_mean/formatters/plain_formatter.rb index e2d995f587..d669588e0f 100644 --- a/lib/did_you_mean/formatters/plain_formatter.rb +++ b/lib/did_you_mean/formatters/plain_formatter.rb @@ -1,33 +1,4 @@ -# frozen-string-literal: true +require_relative '../formatter' -module DidYouMean - # The +DidYouMean::PlainFormatter+ is the basic, default formatter for the - # gem. The formatter responds to the +message_for+ method and it returns a - # human readable string. - class PlainFormatter - - # 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::PlainFormatter.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 - # - def message_for(corrections) - corrections.empty? ? "" : "\nDid you mean? #{corrections.join("\n ")}" - end - end -end +warn "`require 'did_you_mean/formatters/plain_formatter'` is deprecated. Please `require 'did_you_mean/formatter'` " \ + "instead." |