From e82b8b7bf89ae8c69098eaf8bdcae632e7b9c41a Mon Sep 17 00:00:00 2001 From: "Yukihiro \"Matz\" Matsumoto" Date: Sun, 3 May 2020 17:14:26 +0900 Subject: Update `cmpnum` document. `cmpnum` function may return `nil` on error. --- src/numeric.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src/numeric.c') diff --git a/src/numeric.c b/src/numeric.c index 6cfd64280..d1fa47fd0 100644 --- a/src/numeric.c +++ b/src/numeric.c @@ -1474,13 +1474,14 @@ cmpnum(mrb_state *mrb, mrb_value v1, mrb_value v2) /* 15.2.9.3.6 */ /* * call-seq: - * self.f <=> other.f => -1, 0, +1 + * self.f <=> other.f => -1, 0, +1, or nil * < => -1 * = => 0 * > => +1 * Comparison---Returns -1, 0, or +1 depending on whether fix is * less than, equal to, or greater than numeric. This is the - * basis for the tests in Comparable. + * basis for the tests in Comparable. When the operands are + * not comparable, it returns nil instead of raising an exception. */ static mrb_value integral_cmp(mrb_state *mrb, mrb_value self) -- cgit v1.2.3