From c2204ca328817f3d87232471a4e1de0334425752 Mon Sep 17 00:00:00 2001 From: zzak Date: Sat, 23 Feb 2013 03:35:38 +0000 Subject: * 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 --- file.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'file.c') 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 File::Stat 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 -- cgit v1.2.3