* array.c: Document #<=> return values and formatting

* bignum.c: ditto
* file.c: ditto
* object.c: ditto
* numeric.c: ditto
* rational.c: ditto
* string.c: ditto
* time.c: ditto


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39418 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 2 insertions, 0 deletions

diff --git a/array.c b/array.c
index ba93a050ed..84c386cefa 100644
--- a/array.c
+++ b/array.c
@@ -3703,6 +3703,8 @@ recursive_cmp(VALUE ary1, VALUE ary2, int recur)
  *  Comparison --- Returns an integer (+-1+, +0+, or <code>+1</code>) if this
  *  array is less than, equal to, or greater than +other_ary+.
  *
+ *  +nil+ is returned if the two values are incomparable.
+ *
  *  Each object in each array is compared (using the <=> operator).
  *
  *  Arrays are compared in an "element-wise" manner; the first two elements