[ruby/strscan] Mention return value of `rest?` in the doc

(https://github.com/ruby/strscan/pull/49)

The doc of `rest?` was unclear about return value. This commit adds the
return value to the doc.
This commit is contained in:
OKURA Masafumi 2023-01-30 12:07:18 +09:00 коммит произвёл Hiroshi SHIBATA
Родитель a350ef9f7a
Коммит a44f5ab089
1 изменённых файлов: 3 добавлений и 2 удалений

Просмотреть файл

@ -1038,8 +1038,9 @@ strscan_empty_p(VALUE self)
* This method is obsolete; use #eos? instead.
*
* s = StringScanner.new('test string')
* s.eos? # These two
* s.rest? # are opposites.
* # These two are opposites
* s.eos? # => false
* s.rest? # => true
*/
static VALUE
strscan_rest_p(VALUE self)