1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Enhance Range docs

Browse Source 
* Change === docs to mention it uses cover?
* Add different example to === docs to showcase
  behavior better
* Change include? docs to mention cover?
  and clarify the difference
This commit is contained in:
zverok 2019-12-21 22:58:14 +02:00 committed by Nobuyoshi Nakada
parent 4988843188
commit 5a0102cb61
Notes: git 2019-12-22 23:18:03 +09:00 
Merged: https://github.com/ruby/ruby/pull/2768
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
range.c
View File

@ -1373,19 +1373,26 @@ static VALUE range_include_internal(VALUE range, VALUE val, int string_use_cover
* call-seq: * call-seq:
* rng === obj -> true or false * rng === obj -> true or false
* *
* Returns <code>true</code> if +obj+ is an element of the range, * Returns <code>true</code> if +obj+ is between begin and end of range,
* <code>false</code> otherwise. Conveniently, <code>===</code> is the * <code>false</code> otherwise (same as #cover?). Conveniently,
* comparison operator used by <code>case</code> statements. * <code>===</code> is the comparison operator used by <code>case</code>
* statements.
* *
* case 79 * case 79
* when 1..50 then print "low\n" * when 1..50 then puts "low"
* when 51..75 then print "medium\n" * when 51..75 then puts "medium"
* when 76..100 then print "high\n" * when 76..100 then puts "high"
* end * end
* # Prints "high"
* *
* <em>produces:</em> * case "2.6.5"
* when ..."2.4" then puts "EOL"
* when "2.4"..."2.5" then puts "maintenance"
* when "2.5"..."2.7" then puts "stable"
* when "2.7".. then puts "upcoming"
* end
* # Prints "stable"
* *
* high
*/ */
static VALUE static VALUE
@ -1403,12 +1410,19 @@ range_eqq(VALUE range, VALUE val)
* rng.include?(obj) -> true or false * rng.include?(obj) -> true or false
* *
* Returns <code>true</code> if +obj+ is an element of * Returns <code>true</code> if +obj+ is an element of
* the range, <code>false</code> otherwise. If begin and end are * the range, <code>false</code> otherwise.
* numeric, comparison is done according to the magnitude of the values.
* *
* ("a".."z").include?("g") #=> true * ("a".."z").include?("g") #=> true
* ("a".."z").include?("A") #=> false * ("a".."z").include?("A") #=> false
* ("a".."z").include?("cc") #=> false * ("a".."z").include?("cc") #=> false
*
* If you need to ensure +obj+ is between +begin+ and +end+, use #cover?
*
* ("a".."z").cover?("cc") #=> true
*
* If begin and end are numeric, #include? behaves like #cover?
*
* (1..3).include?(1.5) # => true
*/ */
static VALUE static VALUE