From 25ea652c7008df4d78c7da64893b3653c322d005 Mon Sep 17 00:00:00 2001
From: Xavier Noria <fxn@hashref.com>
Date: Sun, 25 Oct 2009 20:46:01 +0100
Subject: AS guide: documents the extension to Range#include?

---
 .../source/active_support_core_extensions.textile     | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'railties/guides/source/active_support_core_extensions.textile')

diff --git a/railties/guides/source/active_support_core_extensions.textile b/railties/guides/source/active_support_core_extensions.textile
index 6bd1e3acbb..7155cb9a79 100644
--- a/railties/guides/source/active_support_core_extensions.textile
+++ b/railties/guides/source/active_support_core_extensions.textile
@@ -1649,6 +1649,25 @@ Active Support extends the method +Range#step+ so that it can be invoked without
 
 As the example shows, in that case the method returns and array with the corresponding elements.
 
+h4. +include?+
+
+The method +Range#include?+ says whether some value falls between the ends of a given instance:
+
+<ruby>
+(2..3).include?(Math::E) # => true
+</ruby>
+
+Active Support extends this method so that the argument may be another range in turn. In that case we test whether the ends of the argument range belong to the receiver themselves:
+
+<ruby>
+(1..10).include?(3..7)  # => true
+(1..10).include?(0..7)  # => false
+(1..10).include?(3..11) # => false
+(1...9).include?(3..9)  # => false
+</ruby>
+
+WARNING: The orginal +Range#include?+ is still the one aliased to +Range#===+.
+
 h3. Extensions to +Proc+
 
 ...
-- 
cgit v1.2.3

