Document options for get_user_input and Readline.new just a little bit.

This commit is contained in:
Pistos 2009-06-19 13:55:30 -04:00
parent 7ae19f4c71
commit 56bfdb0162
2 changed files with 2 additions and 0 deletions

View file

@ -37,6 +37,7 @@ module Diakonos
class Diakonos
# completion_array is the array of strings that tab completion can use
# @param options :initial_text, :completion_array, :history, :do_complete, :on_dirs
def get_user_input( prompt, options = {}, &block )
options[ :history ] ||= @rlh_general
options[ :initial_text ] ||= ""

View file

@ -4,6 +4,7 @@ module Diakonos
# completion_array is the array of strings that tab completion can use
# The block returns true if a refresh is needed?
# @param options :initial_text, :completion_array, :history, :do_complete, :on_dirs
def initialize( diakonos, window, prompt, options = {}, &block )
@diakonos = diakonos
@window = window