Added comment.
authorDaiki Ueno <ueno@unixuser.org>
Wed, 10 Aug 2005 11:30:13 +0000 (11:30 +0000)
committerDaiki Ueno <ueno@unixuser.org>
Wed, 10 Aug 2005 11:30:13 +0000 (11:30 +0000)
lisp/riece-ruby.el

index 2c38afa..2f6beb8 100644 (file)
@@ -1,4 +1,4 @@
-;;; riece-ruby.el --- interact with ruby interpreter
+;;; riece-ruby.el --- interact with Ruby interpreter
 ;; Copyright (C) 1998-2005 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
 
 ;;; Commentary:
 
-;; (riece-ruby-execute "t1" "sleep 30")
-;;
+;; riece-ruby.el is a library to interact with the Ruby interpreter.
+;; It supports concurrent execution of Ruby programs in a single
+;; session.  For example:
+;; 
+;; (riece-ruby-execute "t1" "sleep 30"); returns immediately
+;; => nil
 ;; (riece-ruby-execute "t2" "1 + 1")
-;;
+;; => nil
 ;; (riece-ruby-execute "t3" "\"")
-;;
+;; => nil
 ;; (riece-ruby-inspect "t1")
 ;; => ((OK nil) nil "running")
 ;;
@@ -40,7 +44,6 @@
 ;; => ((OK nil) "(eval):1:in `dispatch_eval': compile error
 ;; (eval):1: unterminated string meets end of file" "exited")
 
-
 ;;; Code:
 
 (defvar riece-ruby-command "ruby"