cliprompt.rb in cliprompt-0.1.1

- old
+ new

@@ -11,10 +11,11 @@
   MSG_YES_OR_NO = "You need to answer by yes, no, y, n, 1 or 0."
   MSG_CHOSE_IN_LIST = "You need to chose between the available options."
   MSG_INPUT_A_NUMBER = "You need input a number."
   MSG_CHOSE_A_NUMBER = "Choose a number:"
 
+  # interactive setup of option
   def ask(question, *options)
     if options[0].class == Optionset
       opts = options[0]
     else
       opts = Optionset.new(*options)
@@ -23,35 +24,43 @@
     answer = input.gets.chomp
     output.flush
     opts.validate(question, answer)
   end
 
+  # if environment var is set, use it, otherwise, ask for a value
   def guess(env, question, *options)
     opts = Optionset.new(*options)
     if ENV[env]
       opts.validate(question, ENV[env])
     else
       ask question, opts
     end
   end
 
+  # output a message
+  # message - string to output
   def say(message)
     output.puts message
   end
 
+  # paints a message in bold and red and output it
+  # message - string to paint
   def shout(message)
     output.puts Paint[message, :bold, :red ]
   end
 
+  # makes possible to set input and output
   def setio(input, output)
     @@input = input
     @@output = output
   end
 
+  # defaults to STDIN
   def input
     @@input ||= STDIN
   end
 
+  # defaults to STDOUT
   def output
     @@output ||= STDOUT
   end
 
 end