From c135883d37d061dd52e15ea7d2c4d38361cf04fb Mon Sep 17 00:00:00 2001
From: zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sat, 23 Feb 2013 02:11:53 +0000
Subject: * object.c (rb_obj_comp): Documenting Object#<=> return values  
 Patch by Stefan Rusterholz

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

(limited to 'object.c')

diff --git a/object.c b/object.c
index ceee4d47eb..76ff316543 100644
--- a/object.c
+++ b/object.c
@@ -1320,6 +1320,17 @@ rb_obj_not_match(VALUE obj1, VALUE obj2)
  *     obj <=> other -> 0 or nil
  *
  *  Returns 0 if obj === other, otherwise nil.
+ *
+ *  The <=> is used by various methods to compare objects, for example
+ *  Enumerable#sort, Enumerable#max etc.
+ *
+ *  Your implementation of <=> should return one of the following values: -1, 0,
+ *  1 or nil. -1 means self is smaller than other. 0 means self is equal to other.
+ *  1 means self is bigger than other. Nil means the two values could not be
+ *  compared.
+ *
+ *  When you defined <=>, you can include Comparable to gain the methods <=, <,
+ *  ==, >=, > and between?.
  */
 static VALUE
 rb_obj_cmp(VALUE obj1, VALUE obj2)
-- 
cgit v1.2.3