merge revision(s) 39418:

* 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/branches/ruby_2_0_0@39666 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nagachika 2013-03-09 13:52:22 +00:00
parent fa4e355e57
commit 9fcf2f8f4b
10 changed files with 74 additions and 41 deletions

View file

@ -1540,13 +1540,14 @@ rb_mod_gt(VALUE mod, VALUE arg)
/*
* call-seq:
* mod <=> other_mod -> -1, 0, +1, or nil
* module <=> other_module -> -1, 0, +1, or nil
*
* Comparison---Returns -1 if <i>mod</i> includes <i>other_mod</i>, 0 if
* <i>mod</i> is the same as <i>other_mod</i>, and +1 if <i>mod</i> is
* included by <i>other_mod</i>. Returns <code>nil</code> if <i>mod</i>
* has no relationship with <i>other_mod</i> or if <i>other_mod</i> is
* not a module.
* Comparison---Returns -1, 0, +1 or nil depending on whether +module+
* includes +other_module+, they are the same, or if +module+ is included by
* +other_module+. This is the basis for the tests in Comparable.
*
* Returns +nil+ if +module+ has no relationship with +other_module+, if
* +other_module+ is not a module, or if the two values are incomparable.
*/
static VALUE