Mention return value of rest? in the doc (#49)

The doc of `rest?` was unclear about return value. This commit adds the return value to the doc.
ruby · Jan 30, 2023 · 0856e23 · 0856e23
1 parent 3ada126
commit 0856e23
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/ext/strscan/strscan.c b/ext/strscan/strscan.c
@@ -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)