From: ueno <ueno>
Date: Wed, 10 Aug 2005 11:30:13 +0000 (+0000)
Subject: Added comment.
X-Git-Tag: channel-coding-branchpoint~176
X-Git-Url: http://git.chise.org/gitweb/?a=commitdiff_plain;h=a1bd7c71e0a78b97c20585ad78bb58f76bd7b573;p=elisp%2Friece.git

Added comment.
---

diff --git a/lisp/riece-ruby.el b/lisp/riece-ruby.el
index 2c38afa..2f6beb8 100644
--- a/lisp/riece-ruby.el
+++ b/lisp/riece-ruby.el
@@ -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>
@@ -24,12 +24,16 @@
 
 ;;; 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"