From: Eric Hodel <drbrain@...7.net>
Date: 2011-12-06T12:31:00+09:00
Subject: [ruby-core:41493] [ruby-trunk - Bug #5656] Improve documentation for Range


Issue #5656 has been updated by Eric Hodel.


=begin
I restored the Xs example in #step since it seemed more illustrative.

I restored the === comment to the === documentation since it isn't something special to Range, all objects can behave that way.

Your second patch cannot be applied because it changes the behavior of Range:

  class X < Range

    def include? other
      false
    end

  end

  r = Range.new 5, 10
  x = X.new 5, 10

  p r === 6
  p x === 6

=end

----------------------------------------
Bug #5656: Improve documentation for Range
http://redmine.ruby-lang.org/issues/5656

Author: Chris Zetter
Status: Closed
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 
ruby -v: ruby 2.0.0dev (2011-11-21 trunk 33804)


I've tried to improve the documentation for range by:
 + adding more examples
 + simplifying existing examples
 + moving case statement example to top level documentation
 + adding and fixing links to methods
 + using consistent terminology and formatting of and parameters and variables
 + clarifying edge cases of methods
 + better explaining of when the succ method is needed

I also wanted to group the '===' operator with 'include?' and 'member?' methods
in the docs. I put this in a seperate patch since it requires code changes.



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