Project

General

Profile

Bug #5656

Improve documentation for Range

Added by zetter (Chris Zetter) almost 9 years ago. Updated almost 9 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
ruby 2.0.0dev (2011-11-21 trunk 33804)
Backport:
[ruby-core:41182]

Description

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.


Files

Also available in: Atom PDF