From: "zzak (Zachary Scott)" <zachary@...>
Date: 2013-04-28T10:40:05+09:00
Subject: [ruby-core:54647] [ruby-trunk - Bug #8242] Fix rdoc of Range#bsearch


Issue #8242 has been updated by zzak (Zachary Scott).


@marcandre What do you suggest?
----------------------------------------
Bug #8242: Fix rdoc of Range#bsearch
https://bugs.ruby-lang.org/issues/8242#change-38987

Author: yhara (Yutaka HARA)
Status: Open
Priority: Normal
Assignee: mame (Yusuke Endoh)
Category: doc
Target version: current: 2.1.0
ruby -v: ruby 2.0.0p0 (2013-02-24 revision 39474) [x86_64-darwin12.2.1]
Backport: 


rdoc of Range#bsearch states "the elements must be sorted", but it does not make sense for Range.

Patch:

diff --git a/range.c b/range.c
index 1e4347e..fab0718 100644
--- a/range.c
+++ b/range.c
@@ -512,11 +512,10 @@ is_integer_p(VALUE v)
  *     rng.bsearch {|obj| block }  -> value
  *
  *  By using binary search, finds a value in range which meets the given
- *  condition in O(log n) where n is the size of the array.
+ *  condition in O(log n) where n is the size of the range.
  *
  *  You can use this method in two use cases: a find-minimum mode and
- *  a find-any mode.  In either case, the elements of the array must be
- *  monotone (or sorted) with respect to the block.
+ *  a find-any mode.
  *
  *  In find-minimum mode (this is a good choice for typical use case),
  *  the block must return true or false, and there must be a value x
@@ -524,7 +523,7 @@ is_integer_p(VALUE v)
  *
  *  - the block returns false for any value which is less than x, and
  *  - the block returns true for any value which is greater than or
- *    equal to i.
+ *    equal to x.
  *
  *  If x is within the range, this method returns the value x.
  *  Otherwise, it returns nil.



-- 
http://bugs.ruby-lang.org/