1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Document that Range#cover? returns false if <=> returns nil

Fixes [Bug #12090]
This commit is contained in:
Jeremy Evans 2019-07-24 10:30:56 -07:00
parent 1cce430324
commit 3556cba503

View file

@ -1455,11 +1455,14 @@ static int r_cover_range_p(VALUE range, VALUE beg, VALUE end, VALUE val);
* the end of the sequence must be calculated, which may exhibit poor
* performance if <code>c</code> is non-numeric.
* Returns <code>false</code> if the begin value of the
* range is larger than the end value.
* range is larger than the end value. Also returns +false+ if one of the
* internal calls to <code><=></code> returns +nil+ (indicating the objects
* are not comparable).
*
* ("a".."z").cover?("c") #=> true
* ("a".."z").cover?("5") #=> false
* ("a".."z").cover?("cc") #=> true
* ("a".."z").cover?(1) #=> false
* (1..5).cover?(2..3) #=> true
* (1..5).cover?(0..6) #=> false
* (1..5).cover?(1...6) #=> true