zzak	2013-02-23 11:11:53 +0900 (Sat, 23 Feb 2013)

  New Revision: 39414

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=39414

  Log:
    * object.c (rb_obj_comp): Documenting Object#<=> return values
      Patch by Stefan Rusterholz

  Modified files:
    trunk/ChangeLog
    trunk/object.c

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 39413)
+++ ChangeLog	(revision 39414)
@@ -1,3 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1
+Sat Feb 23 10:17:00 2013  Zachary Scott  <zachary@z...>
+
+	* object.c (rb_obj_comp): Documenting Object#<=> return values
+	  Patch by Stefan Rusterholz
+
 Sat Feb 23 09:48:41 2013  Nobuyoshi Nakada  <nobu@r...>
 
 	* dir.c (file_s_fnmatch, fnmatch_brace): encoding-incompatible pattern
Index: object.c
===================================================================
--- object.c	(revision 39413)
+++ object.c	(revision 39414)
@@ -1320,6 +1320,17 @@ rb_obj_not_match(VALUE obj1, VALUE obj2) https://github.com/ruby/ruby/blob/trunk/object.c#L1320
  *     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)

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/