diff options
Diffstat (limited to 'ext/pty/lib/expect.rb')
-rw-r--r-- | ext/pty/lib/expect.rb | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/ext/pty/lib/expect.rb b/ext/pty/lib/expect.rb index 5dbfa09ae9..22cbf54115 100644 --- a/ext/pty/lib/expect.rb +++ b/ext/pty/lib/expect.rb @@ -1,19 +1,19 @@ # frozen_string_literal: true $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 # call-seq: # IO#expect(pattern,timeout=9999999) -> Array # IO#expect(pattern,timeout=9999999) { |result| ... } -> nil # + # The +expect+ library adds instance method IO#expect, + # which is similar to the + # {TCL expect extension}[https://www.tcl.tk/man/expect5.31/expect.1.html]. + # + # To use this method, you must require +expect+: + # + # require 'expect' + # # 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. |