added some documentation to command_context run method

This commit is contained in:
John Mair 2011-07-27 23:06:09 +12:00
parent cda95022ed
commit 6ac4cbda4e
1 changed files with 9 additions and 0 deletions

View File

@ -11,6 +11,15 @@ class Pry
attr_accessor :command_set attr_accessor :command_set
attr_accessor :command_processor attr_accessor :command_processor
# Run a command from another command.
# @param [String] command_string The string that invokes the command
# @param [Array] args Further arguments to pass to the command
# @example
# run "show-input"
# @example
# run ".ls"
# @example
# run "amend-line", "5", 'puts "hello world"'
def run(command_string, *args) def run(command_string, *args)
complete_string = "#{command_string} #{args.join(" ")}" complete_string = "#{command_string} #{args.join(" ")}"
command_processor.process_commands(complete_string, eval_string, target) command_processor.process_commands(complete_string, eval_string, target)