Add rdoc about Kernel#<=> [ruby-core:31770]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@29060 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-08-20 05:13:39 +00:00 · 2010-08-20 05:13:39 +00:00 · b88a5027b8
commit b88a5027b8
parent fedc3756fb
1 changed files with 6 additions and 1 deletions
--- a/object.c
+++ b/object.c
@ -1160,7 +1160,12 @@ rb_obj_not_match(VALUE obj1, VALUE obj2)
 }


-/* :nodoc: */
+/*
+ *  call-seq:
+ *     obj <=> other -> 0 or nil
+ *
+ *  Returns 0 if obj === other, otherwise nil.
+ */
 static VALUE
 rb_obj_cmp(VALUE obj1, VALUE obj2)
 {