From 705c567194281322a0a2a38df090384a32124e18 Mon Sep 17 00:00:00 2001
From: marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Wed, 28 Oct 2009 04:50:09 +0000
Subject: * string.c: rdoc for <=>, casecmp

* bignum.c: rdoc for <=>

* file.c: ditto

* time.c: ditto

* compar.c: rdoc

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25522 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 compar.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'compar.c')

diff --git a/compar.c b/compar.c
index e8ebfc5bfa..4db42913db 100644
--- a/compar.c
+++ b/compar.c
@@ -163,7 +163,9 @@ cmp_between(VALUE x, VALUE min, VALUE max)
  *  may be ordered. The class must define the <code><=></code> operator,
  *  which compares the receiver against another object, returning -1, 0,
  *  or +1 depending on whether the receiver is less than, equal to, or
- *  greater than the other object. <code>Comparable</code> uses
+ *  greater than the other object. If the other object is not comparable
+ *  then the <code><=></code> operator should return nil.
+ *  <code>Comparable</code> uses
  *  <code><=></code> to implement the conventional comparison operators
  *  (<code><</code>, <code><=</code>, <code>==</code>, <code>>=</code>,
  *  and <code>></code>) and the method <code>between?</code>.
-- 
cgit v1.2.3