diff options
author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2022-10-02 08:24:08 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-02 08:24:08 -0500 |
commit | ded895baa96cb9622fcd44d308fb48341565605b (patch) | |
tree | 5925adf7e6bd53340e5e94a873e76a66fc5499b3 /ext/pty/lib | |
parent | 85fc822307ee95f351be79934e78c3b9d4102f8a (diff) | |
download | ruby-ded895baa96cb9622fcd44d308fb48341565605b.tar.gz |
[DOC] RDoc changes for IO (#6458)
Moves Expect library doc into io.c.
Changes certain links to local sections, now pointing to sections in doc/io_streams.rdoc.
Removes local sections now superseded by sections in doc/io_streams.rdoc.
Diffstat (limited to 'ext/pty/lib')
-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. |