summaryrefslogtreecommitdiff
path: root/doc/pty/README.expect.ja
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2024-04-07 13:35:20 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2024-04-07 13:35:20 +0900
commiteaa6e4b22862a31c9595d052f7c63ce997a95d68 (patch)
tree8e6ac143a5caa03cc83110948e93149f78a69c68 /doc/pty/README.expect.ja
parent6bfabd076b99bd47ee10277b8de24aaa791be69b (diff)
[DOC] Update PTY documents
- Fix markups as RDoc. - Remove already descriptions of removed methods.
Diffstat (limited to 'doc/pty/README.expect.ja')
-rw-r--r--doc/pty/README.expect.ja32
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/pty/README.expect.ja b/doc/pty/README.expect.ja
index 7c0456f24f..a4eb6b01df 100644
--- a/doc/pty/README.expect.ja
+++ b/doc/pty/README.expect.ja
@@ -1,21 +1,23 @@
- README for expect
+= README for expect
by A. Ito, 28 October, 1998
- Expectライブラリは,tcl の expect パッケージと似たような機能を
+Expectライブラリは,tcl の expect パッケージと似たような機能を
IOクラスに追加します.
- 追加されるメソッドの使い方は次の通りです.
+追加されるメソッドの使い方は次の通りです.
- IO#expect(pattern,timeout=9999999)
+[IO#expect(pattern,timeout=9999999)]
-pattern は String か Regexp のインスタンス,timeout は Fixnum
-のインスタンスです.timeout は省略できます.
- このメソッドがブロックなしで呼ばれた場合,まずレシーバである
-IOオブジェクトから pattern にマッチするパターンが読みこまれる
-まで待ちます.パターンが得られたら,そのパターンに関する配列を
-返します.配列の最初の要素は,pattern にマッチするまでに読みこ
-まれた内容の文字列です.2番目以降の要素は,pattern の正規表現
-の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
-もしタイムアウトが起きた場合は,このメソッドはnilを返します.
- このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
-配列がブロック引数として渡され,ブロックが評価されます.
+ _pattern_ は String か Regexp のインスタンス,_timeout_ は Fixnum
+ のインスタンスです._timeout_ は省略できます.
+
+ このメソッドがブロックなしで呼ばれた場合,まずレシーバである
+ IOオブジェクトから _pattern_ にマッチするパターンが読みこまれる
+ まで待ちます.パターンが得られたら,そのパターンに関する配列を
+ 返します.配列の最初の要素は,_pattern_ にマッチするまでに読みこ
+ まれた内容の文字列です.2番目以降の要素は,_pattern_ の正規表現
+ の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
+ もしタイムアウトが起きた場合は,このメソッドは +nil+ を返します.
+
+ このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
+ 配列がブロック引数として渡され,ブロックが評価されます.