* 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, 4 insertions, 2 deletions

diff --git a/file.c b/file.c
index 69b5a7cf4b..6742cf022e 100644
--- a/file.c
+++ b/file.c
@@ -326,8 +326,10 @@ static struct timespec stat_mtimespec(struct stat *st);
  *  call-seq:
  *     stat <=> other_stat    -> -1, 0, 1, nil
  *
- *  Compares <code>File::Stat</code> objects by comparing their
- *  respective modification times.
+ *  Compares File::Stat objects by comparing their respective modification
+ *  times.
+ *
+ *  +nil+ is returned if the two values are incomparable.
  *
  *     f1 = File.new("f1", "w")
  *     sleep 1