RDoc for Complex

This commit is contained in:
BurdetteLamar 2023-12-19 14:32:54 -06:00 committed by Peter Zhu
parent 054f56fd3e
commit f0b86f8c60

View File

@ -1653,10 +1653,15 @@ nucomp_inspect(VALUE self)
/* /*
* call-seq: * call-seq:
* cmp.finite? -> true or false * finite? -> true or false
* *
* Returns +true+ if +cmp+'s real and imaginary parts are both finite numbers, * Returns +true+ if both <tt>self.real.finite?</tt> and <tt>self.imag.finite?</tt>
* otherwise returns +false+. * are true, +false+ otherwise:
*
* Complex(1, 1).finite? # => true
* Complex(Float::INFINITY, 0).finite? # => false
*
* Related: Numeric#finite?, Float#finite?.
*/ */
static VALUE static VALUE
rb_complex_finite_p(VALUE self) rb_complex_finite_p(VALUE self)
@ -1668,15 +1673,15 @@ rb_complex_finite_p(VALUE self)
/* /*
* call-seq: * call-seq:
* cmp.infinite? -> nil or 1 * infinite? -> 1 or nil
* *
* Returns +1+ if +cmp+'s real or imaginary part is an infinite number, * Returns +1+ if either <tt>self.real.infinite?</tt> or <tt>self.imag.infinite?</tt>
* otherwise returns +nil+. * is true, +nil+ otherwise:
* *
* For example: * Complex(Float::INFINITY, 0).infinite? # => 1
* Complex(1, 1).infinite? # => nil
* *
* (1+1i).infinite? #=> nil * Related: Numeric#infinite?, Float#infinite?.
* (Float::INFINITY + 1i).infinite? #=> 1
*/ */
static VALUE static VALUE
rb_complex_infinite_p(VALUE self) rb_complex_infinite_p(VALUE self)