summaryrefslogtreecommitdiff
path: root/complex.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-03-26 00:02:20 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-03-26 00:02:20 +0000
commit2e1a3725c790276ef4274599c16aea0ab85145b4 (patch)
treee70f58bb4b6a21ea54680e60a7a9e48975532f83 /complex.c
parentba77b725da3065e89981b0c7a599db165cb0bd96 (diff)
Update Complex#infinite? documenation
to state what it really does. [Fix GH-1848] From: Christian Bruckmayer <cbruckmayer@suse.com> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62921 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'complex.c')
-rw-r--r--complex.c6
1 files changed, 2 insertions, 4 deletions
diff --git a/complex.c b/complex.c
index c6daefdb99..7400dea5d2 100644
--- a/complex.c
+++ b/complex.c
@@ -1273,10 +1273,8 @@ rb_complex_finite_p(VALUE self)
* call-seq:
* cmp.infinite? -> nil or 1
*
- * Returns values corresponding to the value of +cmp+'s magnitude:
- *
- * +finite+:: +nil+
- * ++Infinity+:: ++1+
+ * Returns +1+ if +cmp+'s real or imaginary value is an infinite number,
+ * otherwise returns +nil+.
*
* For example:
*