From 451b45605161a801e8a1e3c53e02d74de82a096a Mon Sep 17 00:00:00 2001
From: Marcus Stollsteimer <sto.mar@web.de>
Date: Wed, 23 Dec 2020 17:41:16 +0100
Subject: [ruby/io-console] [DOC] Note that IO#getpass returns a chomped string

IO#getpass uses String#chomp! on the read input line.

https://github.com/ruby/io-console/commit/1e98c93bc8
---
 ext/io/console/console.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/ext/io/console/console.c b/ext/io/console/console.c
index ff4df73693..1fb1609b4d 100644
--- a/ext/io/console/console.c
+++ b/ext/io/console/console.c
@@ -1574,6 +1574,10 @@ str_chomp(VALUE str)
  * Reads and returns a line without echo back.
  * Prints +prompt+ unless it is +nil+.
  *
+ * The newline character that terminates the
+ * read line is removed from the returned string,
+ * see String#chomp!.
+ *
  * You must require 'io/console' to use this method.
  */
 static VALUE
-- 
cgit v1.2.3