From dec802d8b59900e57e18fa6712caf95f12324aea Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@ruby-lang.org>
Date: Mon, 17 Feb 2020 12:02:58 +0900
Subject: [ruby/io-console] [DOC] Improved about `intr:`

https://github.com/ruby/io-console/commit/82b630cd79
---
 ext/io/console/console.c | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/ext/io/console/console.c b/ext/io/console/console.c
index f67e6805bc..9baad2bf17 100644
--- a/ext/io/console/console.c
+++ b/ext/io/console/console.c
@@ -360,9 +360,9 @@ ttymode_with_io(VALUE io, VALUE (*func)(VALUE, VALUE), VALUE farg, void (*setter
 
 /*
  * call-seq:
- *   io.raw(min: nil, time: nil) {|io| }
+ *   io.raw(min: nil, time: nil, intr: nil) {|io| }
  *
- * Yields +self+ within raw mode.
+ * Yields +self+ within raw mode, and returns the result of the block.
  *
  *   STDIN.raw(&:gets)
  *
@@ -374,6 +374,9 @@ ttymode_with_io(VALUE io, VALUE (*func)(VALUE, VALUE), VALUE farg, void (*setter
  * The parameter +time+ specifies the timeout in _seconds_ with a
  * precision of 1/10 of a second. (default: 0)
  *
+ * If the parameter +intr+ is +true+, enables break, interrupt, quit,
+ * and suspend special characters.
+ *
  * Refer to the manual page of termios for further details.
  *
  * You must require 'io/console' to use this method.
@@ -387,11 +390,11 @@ console_raw(int argc, VALUE *argv, VALUE io)
 
 /*
  * call-seq:
- *   io.raw!(min: nil, time: nil)
+ *   io.raw!(min: nil, time: nil, intr: nil) -> io
  *
- * Enables raw mode.
+ * Enables raw mode, and returns +io+.
  *
- * If the terminal mode needs to be back, use io.raw { ... }.
+ * If the terminal mode needs to be back, use <code>io.raw { ... }</code>.
  *
  * See IO#raw for details on the parameters.
  *
@@ -487,7 +490,7 @@ nogvl_getch(void *p)
 
 /*
  * call-seq:
- *   io.getch(min: nil, time: nil)       -> char
+ *   io.getch(min: nil, time: nil, intr: nil) -> char
  *
  * Reads and returns a character in raw mode.
  *
@@ -1494,7 +1497,7 @@ console_dev(int argc, VALUE *argv, VALUE klass)
 
 /*
  * call-seq:
- *   io.getch(min: nil, time: nil)       -> char
+ *   io.getch(min: nil, time: nil, intr: nil) -> char
  *
  * See IO#getch.
  */
-- 
cgit v1.2.3