summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog5
-rw-r--r--doc/pty/README.expect22
-rw-r--r--ext/pty/lib/expect.rb22
3 files changed, 26 insertions, 23 deletions
diff --git a/ChangeLog b/ChangeLog
index a1bb258..85d6c4c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Wed Feb 6 23:30:00 2013 Zachary Scott <zachary@zacharyscott.net>
+
+ * doc/pty/README.expect: Removed static documentation file
+ * ext/pty/lib/expect.rb: Documentation for IO#expect
+
Wed Feb 6 22:25:00 2013 Charlie Somerville <charlie@charliesomerville.com>
* hash.c (env_reject_bang): hide keys array from ObjectSpace
diff --git a/doc/pty/README.expect b/doc/pty/README.expect
deleted file mode 100644
index fddbb6f..0000000
--- a/doc/pty/README.expect
+++ /dev/null
@@ -1,22 +0,0 @@
- README for expect
- by A. Ito, 28 October, 1998
-
- Expect library adds IO class a method called expect(), which
-does similar act to tcl's expect extension.
-
-The usage of the method is:
-
- IO#expect(pattern,timeout=9999999)
-
-where `pattern' is an instance of String or Regexp and `timeout'
-is Fixnum, which can be omitted.
- When the method is called without block, it waits until the
-input which matches the pattern is obtained from the IO or the time
-specified as the timeout passes. When the pattern is obtained from the
-IO, the method returns an array. The first element of the array is the
-entire string obtained from the IO until the pattern matches. The
-following elements indicates the specific pattern which matched to the
-anchor in the regular expression. If the method ends because of
-timeout, it returns nil.
- When the method is called with block, the array is passed as
-the block parameter.
diff --git a/ext/pty/lib/expect.rb b/ext/pty/lib/expect.rb
index c15044b..06f4243 100644
--- a/ext/pty/lib/expect.rb
+++ b/ext/pty/lib/expect.rb
@@ -1,10 +1,30 @@
$expect_verbose = false
+# Expect library adds the IO instance method #expect, which does similar act to
+# tcl's expect extension.
+#
+# In order to use this method, you must require expect:
+#
+# require 'expect'
+#
+# Please see #expect for usage.
class IO
- # Reads from the IO until pattern +pat+ matches or the +timeout+ is over.
+ # call-seq:
+ # IO#expect(pattern,timeout=9999999) -> Array
+ # IO#expect(pattern,timeout=9999999) { |result| ... } -> nil
+ #
+ # Reads from the IO until the given +pattern+ matches or the +timeout+ is over.
+ #
# It returns an array with the read buffer, followed by the matches.
# If a block is given, the result is yielded to the block and returns nil.
#
+ # When called without a block, it waits until the input that matches the
+ # given +pattern+ is obtained from the IO or the time specified as the
+ # timeout passes. An array is returned when the pattern is obtained from the
+ # IO. The first element of the array is the entire string obtained from the
+ # IO until the pattern matches, followed by elements indicating which the
+ # pattern which matched to the anchor in the regular expression.
+ #
# The optional timeout parameter defines, in seconds, the total time to wait
# for the pattern. If the timeout expires or eof is found, nil is returned
# or yielded. However, the buffer in a timeout session is kept for the next