knu	2017-11-07 14:28:14 +0900 (Tue, 07 Nov 2017)

  New Revision: 60685

  https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=60685

  Log:
    Add details on the min/time parameters to the rdoc

  Modified files:
    trunk/ext/io/console/console.c
Index: ext/io/console/console.c
===================================================================
--- ext/io/console/console.c	(revision 60684)
+++ ext/io/console/console.c	(revision 60685)
@@ -307,6 +307,15 @@ ttymode(VALUE io, VALUE (*func)(VALUE), https://github.com/ruby/ruby/blob/trunk/ext/io/console/console.c#L307
  *
  * will read and return a line without echo back and line editing.
  *
+ * The parameter +min+ specifies the minimum number of bytes that
+ * should be received when the read operation is performed. (default:
+ * 1)
+ *
+ * The paramter +time+ specifies the timeout in _seconds_, with a
+ * precision of 1/10 of a second. (default: 0)
+ *
+ * Refer to the manual page of termios for further details.
+ *
  * You must require 'io/console' to use this method.
  */
 static VALUE
@@ -324,6 +333,8 @@ console_raw(int argc, VALUE *argv, VALUE https://github.com/ruby/ruby/blob/trunk/ext/io/console/console.c#L333
  *
  * If the terminal mode needs to be back, use io.raw { ... }.
  *
+ * See IO#raw for details on the parameters.
+ *
  * You must require 'io/console' to use this method.
  */
 static VALUE
@@ -397,6 +408,8 @@ getc_call(VALUE io) https://github.com/ruby/ruby/blob/trunk/ext/io/console/console.c#L408
  *
  * Reads and returns a character in raw mode.
  *
+ * See IO#raw for details on the parameters.
+ *
  * You must require 'io/console' to use this method.
  */
 static VALUE

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/