lib/tty/prompt/suggestion.rb in tty-prompt-0.2.0 vs lib/tty/prompt/suggestion.rb in tty-prompt-0.3.0

@@ -1,12 +1,14 @@
 # encoding: utf-8
 
 require 'tty/prompt/distance'
 
 module TTY
-  # A class responsible for shell prompt interactions.
+  # A class responsible for terminal prompt interactions.
   class Prompt
-    # A class representing a suggestion
+    # A class representing a suggestion out of possible choices
+    #
+    # @api public
     class Suggestion
       DEFAULT_INDENT = 8
 
       SINGLE_TEXT    = 'Did you mean this?'