mirror of
https://github.com/ruby/ruby.git
synced 2025-09-15 16:44:01 +02:00
[DOC] Fix formatting for What's Here in IO (#5719)
* Fix formatting for What's Here in IO * Repair formatting in What's Heres in numeric.c * Fix formatting for What's Here in IO
This commit is contained in:
Burdette Lamar
GitHub
parent
1a002d9ade
commit
7f93b7dc88
Notes:
git
2022-03-26 05:44:07 +09:00
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2 changed files with 232 additions and 232 deletions
266
numeric.c
266
numeric.c
|
|
@ -968,46 +968,45 @@ num_negative_p(VALUE num)
|
|||
*
|
||||
* === Querying
|
||||
*
|
||||
* - #finite?:: Returns whether +self+ is finite.
|
||||
* - #hash:: Returns the integer hash code for +self+.
|
||||
* - #infinite?:: Returns whether +self+ is infinite.
|
||||
* - #nan?:: Returns whether +self+ is a NaN (not-a-number).
|
||||
* - #finite?: Returns whether +self+ is finite.
|
||||
* - #hash: Returns the integer hash code for +self+.
|
||||
* - #infinite?: Returns whether +self+ is infinite.
|
||||
* - #nan?: Returns whether +self+ is a NaN (not-a-number).
|
||||
*
|
||||
* === Comparing
|
||||
*
|
||||
* - #<:: Returns whether +self+ is less than the given value.
|
||||
* - #<=:: Returns whether +self+ is less than or equal to the given value.
|
||||
* - #<=>:: Returns a number indicating whether +self+ is less than, equal
|
||||
* to, or greater than the given value.
|
||||
* - #== (aliased as #=== and #eql?):: Returns whether +self+ is equal to
|
||||
* the given value.
|
||||
* - #>:: Returns whether +self+ is greater than the given value.
|
||||
* - #>=:: Returns whether +self+ is greater than or equal to the given
|
||||
* value.
|
||||
* - {<}[#method-i-3C]: Returns whether +self+ is less than the given value.
|
||||
* - {<=}[#method-i-3C-3D]: Returns whether +self+ is less than or equal to the given value.
|
||||
* - {<=>}[#method-i-3C-3D-3E]: Returns a number indicating whether +self+ is less than, equal
|
||||
* to, or greater than the given value.
|
||||
* - #== (aliased as #=== and #eql?): Returns whether +self+ is equal to
|
||||
* the given value.
|
||||
* - {>}[#method-i-3E]: Returns whether +self+ is greater than the given value.
|
||||
* - {>=}[#method-i-3E-3D]: Returns whether +self+ is greater than or equal to the given value.
|
||||
*
|
||||
* === Converting
|
||||
*
|
||||
* - #% (aliased as #modulo):: Returns +self+ modulo the given value.
|
||||
* - #*:: Returns the product of +self+ and the given value.
|
||||
* - #**:: Returns the value of +self+ raised to the power of the given value.
|
||||
* - #+:: Returns the sum of +self+ and the given value.
|
||||
* - #-:: Returns the difference of +self+ and the given value.
|
||||
* - #/:: Returns the quotient of +self+ and the given value.
|
||||
* - #ceil:: Returns the smallest number greater than or equal to +self+.
|
||||
* - #coerce:: Returns a 2-element array containing the given value converted to a \Float
|
||||
and +self+
|
||||
* - #divmod:: Returns a 2-element array containing the quotient and remainder
|
||||
* results of dividing +self+ by the given value.
|
||||
* - #fdiv:: Returns the Float result of dividing +self+ by the given value.
|
||||
* - #floor:: Returns the greatest number smaller than or equal to +self+.
|
||||
* - #next_float:: Returns the next-larger representable \Float.
|
||||
* - #prev_float:: Returns the next-smaller representable \Float.
|
||||
* - #quo:: Returns the quotient from dividing +self+ by the given value.
|
||||
* - #round:: Returns +self+ rounded to the nearest value, to a given precision.
|
||||
* - #to_i (aliased as #to_int):: Returns +self+ truncated to an Integer.
|
||||
* - #to_s (aliased as #inspect):: Returns a string containing the place-value
|
||||
* representation of +self+ in the given radix.
|
||||
* - #truncate:: Returns +self+ truncated to a given precision.
|
||||
* - #% (aliased as #modulo): Returns +self+ modulo the given value.
|
||||
* - #*: Returns the product of +self+ and the given value.
|
||||
* - #**: Returns the value of +self+ raised to the power of the given value.
|
||||
* - #+: Returns the sum of +self+ and the given value.
|
||||
* - #-: Returns the difference of +self+ and the given value.
|
||||
* - {/}[#method-i-2F]: Returns the quotient of +self+ and the given value.
|
||||
* - #ceil: Returns the smallest number greater than or equal to +self+.
|
||||
* - #coerce: Returns a 2-element array containing the given value converted to a \Float
|
||||
and +self+
|
||||
* - #divmod: Returns a 2-element array containing the quotient and remainder
|
||||
* results of dividing +self+ by the given value.
|
||||
* - #fdiv: Returns the Float result of dividing +self+ by the given value.
|
||||
* - #floor: Returns the greatest number smaller than or equal to +self+.
|
||||
* - #next_float: Returns the next-larger representable \Float.
|
||||
* - #prev_float: Returns the next-smaller representable \Float.
|
||||
* - #quo: Returns the quotient from dividing +self+ by the given value.
|
||||
* - #round: Returns +self+ rounded to the nearest value, to a given precision.
|
||||
* - #to_i (aliased as #to_int): Returns +self+ truncated to an Integer.
|
||||
* - #to_s (aliased as #inspect): Returns a string containing the place-value
|
||||
* representation of +self+ in the given radix.
|
||||
* - #truncate: Returns +self+ truncated to a given precision.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
@ -3505,66 +3504,65 @@ rb_num2ull(VALUE val)
|
|||
*
|
||||
* === Querying
|
||||
*
|
||||
* - #allbits?:: Returns whether all bits in +self+ are set.
|
||||
* - #anybits?:: Returns whether any bits in +self+ are set.
|
||||
* - #nobits?:: Returns whether no bits in +self+ are set.
|
||||
* - #allbits?: Returns whether all bits in +self+ are set.
|
||||
* - #anybits?: Returns whether any bits in +self+ are set.
|
||||
* - #nobits?: Returns whether no bits in +self+ are set.
|
||||
*
|
||||
* === Comparing
|
||||
*
|
||||
* - #<:: Returns whether +self+ is less than the given value.
|
||||
* - #<=:: Returns whether +self+ is less than or equal to the given value.
|
||||
* - #<=>:: Returns a number indicating whether +self+ is less than, equal
|
||||
* to, or greater than the given value.
|
||||
* - #== (aliased as #===):: Returns whether +self+ is equal to the given
|
||||
* - {<}[#method-i-3C]: Returns whether +self+ is less than the given value.
|
||||
* - {<=}[#method-i-3C-3D]: Returns whether +self+ is less than or equal to the given value.
|
||||
* - {<=>}[#method-i-3C-3D-3E]: Returns a number indicating whether +self+ is less than, equal
|
||||
* to, or greater than the given value.
|
||||
* - #== (aliased as #===): Returns whether +self+ is equal to the given
|
||||
* value.
|
||||
* - #>:: Returns whether +self+ is greater than the given value.
|
||||
* - #>=:: Returns whether +self+ is greater than or equal to the given
|
||||
* value.
|
||||
* - {>}[#method-i-3E]: Returns whether +self+ is greater than the given value.
|
||||
* - {>=}[#method-i-3E-3D]: Returns whether +self+ is greater than or equal to the given value.
|
||||
*
|
||||
* === Converting
|
||||
*
|
||||
* - ::sqrt:: Returns the integer square root of the given value.
|
||||
* - ::try_convert:: Returns the given value converted to an \Integer.
|
||||
* - #% (aliased as #modulo):: Returns +self+ modulo the given value.
|
||||
* - #&:: Returns the bitwise AND of +self+ and the given value.
|
||||
* - #*:: Returns the product of +self+ and the given value.
|
||||
* - #**:: Returns the value of +self+ raised to the power of the given value.
|
||||
* - #+:: Returns the sum of +self+ and the given value.
|
||||
* - #-:: Returns the difference of +self+ and the given value.
|
||||
* - #/:: Returns the quotient of +self+ and the given value.
|
||||
* - #<<:: Returns the value of +self+ after a leftward bit-shift.
|
||||
* - #>>:: Returns the value of +self+ after a rightward bit-shift.
|
||||
* - #[]:: Returns a slice of bits from +self+.
|
||||
* - #^:: Returns the bitwise EXCLUSIVE OR of +self+ and the given value.
|
||||
* - #ceil:: Returns the smallest number greater than or equal to +self+.
|
||||
* - #chr:: Returns a 1-character string containing the character
|
||||
* represented by the value of +self+.
|
||||
* - #digits:: Returns an array of integers representing the base-radix digits
|
||||
* of +self+.
|
||||
* - #div:: Returns the integer result of dividing +self+ by the given value.
|
||||
* - #divmod:: Returns a 2-element array containing the quotient and remainder
|
||||
* results of dividing +self+ by the given value.
|
||||
* - #fdiv:: Returns the Float result of dividing +self+ by the given value.
|
||||
* - #floor:: Returns the greatest number smaller than or equal to +self+.
|
||||
* - #pow:: Returns the modular exponentiation of +self+.
|
||||
* - #pred:: Returns the integer predecessor of +self+.
|
||||
* - #remainder:: Returns the remainder after dividing +self+ by the given value.
|
||||
* - #round:: Returns +self+ rounded to the nearest value with the given precision.
|
||||
* - #succ (aliased as #next):: Returns the integer successor of +self+.
|
||||
* - #to_f:: Returns +self+ converted to a Float.
|
||||
* - #to_s (aliased as #inspect):: Returns a string containing the place-value
|
||||
* representation of +self+ in the given radix.
|
||||
* - #truncate:: Returns +self+ truncated to the given precision.
|
||||
* - #/:: Returns the bitwise OR of +self+ and the given value.
|
||||
* - ::sqrt: Returns the integer square root of the given value.
|
||||
* - ::try_convert: Returns the given value converted to an \Integer.
|
||||
* - #% (aliased as #modulo): Returns +self+ modulo the given value.
|
||||
* - {&}[#method-i-26]: Returns the bitwise AND of +self+ and the given value.
|
||||
* - #*: Returns the product of +self+ and the given value.
|
||||
* - #**: Returns the value of +self+ raised to the power of the given value.
|
||||
* - #+: Returns the sum of +self+ and the given value.
|
||||
* - #-: Returns the difference of +self+ and the given value.
|
||||
* - {/}[#method-i-2F]: Returns the quotient of +self+ and the given value.
|
||||
* - #<<: Returns the value of +self+ after a leftward bit-shift.
|
||||
* - #>>: Returns the value of +self+ after a rightward bit-shift.
|
||||
* - #[]: Returns a slice of bits from +self+.
|
||||
* - {^}[#method-i-5E]: Returns the bitwise EXCLUSIVE OR of +self+ and the given value.
|
||||
* - #ceil: Returns the smallest number greater than or equal to +self+.
|
||||
* - #chr: Returns a 1-character string containing the character
|
||||
* represented by the value of +self+.
|
||||
* - #digits: Returns an array of integers representing the base-radix digits
|
||||
* of +self+.
|
||||
* - #div: Returns the integer result of dividing +self+ by the given value.
|
||||
* - #divmod: Returns a 2-element array containing the quotient and remainder
|
||||
* results of dividing +self+ by the given value.
|
||||
* - #fdiv: Returns the Float result of dividing +self+ by the given value.
|
||||
* - #floor: Returns the greatest number smaller than or equal to +self+.
|
||||
* - #pow: Returns the modular exponentiation of +self+.
|
||||
* - #pred: Returns the integer predecessor of +self+.
|
||||
* - #remainder: Returns the remainder after dividing +self+ by the given value.
|
||||
* - #round: Returns +self+ rounded to the nearest value with the given precision.
|
||||
* - #succ (aliased as #next): Returns the integer successor of +self+.
|
||||
* - #to_f: Returns +self+ converted to a Float.
|
||||
* - #to_s (aliased as #inspect): Returns a string containing the place-value
|
||||
* representation of +self+ in the given radix.
|
||||
* - #truncate: Returns +self+ truncated to the given precision.
|
||||
* - {|}[#method-i-7C]: Returns the bitwise OR of +self+ and the given value.
|
||||
*
|
||||
* === Other
|
||||
*
|
||||
* - #downto:: Calls the given block with each integer value from +self+
|
||||
* down to the given value.
|
||||
* - #times:: Calls the given block +self+ times with each integer
|
||||
* in <tt>(0..self-1)</tt>.
|
||||
* - #upto:: Calls the given block with each integer value from +self+
|
||||
* up to the given value.
|
||||
* - #downto: Calls the given block with each integer value from +self+
|
||||
* down to the given value.
|
||||
* - #times: Calls the given block +self+ times with each integer
|
||||
* in <tt>(0..self-1)</tt>.
|
||||
* - #upto: Calls the given block with each integer value from +self+
|
||||
* up to the given value.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
@ -6109,68 +6107,70 @@ int_s_try_convert(VALUE self, VALUE num)
|
|||
*
|
||||
* === Querying
|
||||
*
|
||||
* - #finite?:: Returns true unless +self+ is infinite or not a number.
|
||||
* - #infinite?:: Returns -1, +nil+ or +1, depending on whether +self+
|
||||
* is <tt>-Infinity<tt>, finite, or <tt>+Infinity</tt>.
|
||||
* - #integer?:: Returns whether +self+ is an integer.
|
||||
* - #negative?:: Returns whether +self+ is negative.
|
||||
* - #nonzero?:: Returns whether +self+ is not zero.
|
||||
* - #positive?:: Returns whether +self+ is positive.
|
||||
* - #real?:: Returns whether +self+ is a real value.
|
||||
* - #zero?:: Returns whether +self+ is zero.
|
||||
* - #finite?: Returns true unless +self+ is infinite or not a number.
|
||||
* - #infinite?: Returns -1, +nil+ or +1, depending on whether +self+
|
||||
* is <tt>-Infinity<tt>, finite, or <tt>+Infinity</tt>.
|
||||
* - #integer?: Returns whether +self+ is an integer.
|
||||
* - #negative?: Returns whether +self+ is negative.
|
||||
* - #nonzero?: Returns whether +self+ is not zero.
|
||||
* - #positive?: Returns whether +self+ is positive.
|
||||
* - #real?: Returns whether +self+ is a real value.
|
||||
* - #zero?: Returns whether +self+ is zero.
|
||||
*
|
||||
* === Comparing
|
||||
*
|
||||
* - #<=>:: Returns:
|
||||
* - {<=>}[#method-i-3C-3D-3E]: Returns:
|
||||
*
|
||||
* - -1 if +self+ is less than the given value.
|
||||
* - 0 if +self+ is equal to the given value.
|
||||
* - 1 if +self+ is greater than the given value.
|
||||
* - +nil+ if +self+ and the given value are not comparable.
|
||||
* - #eql?:: Returns whether +self+ and the given value have the same value and type.
|
||||
*
|
||||
* - #eql?: Returns whether +self+ and the given value have the same value and type.
|
||||
*
|
||||
* === Converting
|
||||
*
|
||||
* - #% (aliased as #modulo):: Returns the remainder of +self+ divided by the given value.
|
||||
* - #-@:: Returns the value of +self+, negated.
|
||||
* - #abs (aliased as #magnitude):: Returns the absolute value of +self+.
|
||||
* - #abs2:: Returns the square of +self+.
|
||||
* - #angle (aliased as #arg and #phase):: Returns 0 if +self+ is positive,
|
||||
* Math::PI otherwise.
|
||||
* - #ceil:: Returns the smallest number greater than or equal to +self+,
|
||||
* to a given precision.
|
||||
* - #coerce:: Returns array <tt>[coerced_self, coerced_other]</tt>
|
||||
* for the given other value.
|
||||
* - #conj (aliased as #conjugate):: Returns the complex conjugate of +self+.
|
||||
* - #denominator:: Returns the denominator (always positive)
|
||||
* of the Rational representation of +self+.
|
||||
* - #div:: Returns the value of +self+ divided by the given value
|
||||
* and converted to an integer.
|
||||
* - #divmod:: Returns array <tt>[quotient, modulus]</tt> resulting
|
||||
* from dividing +self+ the given divisor.
|
||||
* - #fdiv:: Returns the Float result of dividing +self+ by the given divisor.
|
||||
* - #floor:: Returns the largest number less than or equal to +self+,
|
||||
* to a given precision.
|
||||
* - #i:: Returns the Complex object <tt>Complex(0, self)</tt>.
|
||||
* the given value.
|
||||
* - #imaginary (aliased as #imag):: Returns the imaginary part of the +self+.
|
||||
* - #numerator:: Returns the numerator of the Rational representation of +self+;
|
||||
* has the same sign as +self+.
|
||||
* - #polar:: Returns the array <tt>[self.abs, self.arg]</tt>.
|
||||
* - #quo:: Returns the value of +self+ divided by the given value.
|
||||
* - #real:: Returns the real part of +self+.
|
||||
* - #rect (aliased as #rectangular):: Returns the array <tt>[self, 0]</tt>.
|
||||
* - #remainder:: Returns <tt>self-arg*(self/arg).truncate</tt> for the given +arg+.
|
||||
* - #round:: Returns the value of +self+ rounded to the nearest value
|
||||
* for the given a precision.
|
||||
* - #to_c:: Returns the Complex representation of +self+.
|
||||
* - #to_int:: Returns the Integer representation of +self+, truncating if necessary.
|
||||
* - #truncate:: Returns +self+ truncated (toward zero) to a given precision.
|
||||
* - #% (aliased as #modulo): Returns the remainder of +self+ divided by the given value.
|
||||
* - #-@: Returns the value of +self+, negated.
|
||||
* - #abs (aliased as #magnitude): Returns the absolute value of +self+.
|
||||
* - #abs2: Returns the square of +self+.
|
||||
* - #angle (aliased as #arg and #phase): Returns 0 if +self+ is positive,
|
||||
* Math::PI otherwise.
|
||||
* - #ceil: Returns the smallest number greater than or equal to +self+,
|
||||
* to a given precision.
|
||||
* - #coerce: Returns array <tt>[coerced_self, coerced_other]</tt>
|
||||
* for the given other value.
|
||||
* - #conj (aliased as #conjugate): Returns the complex conjugate of +self+.
|
||||
* - #denominator: Returns the denominator (always positive)
|
||||
* of the Rational representation of +self+.
|
||||
* - #div: Returns the value of +self+ divided by the given value
|
||||
* and converted to an integer.
|
||||
* - #divmod: Returns array <tt>[quotient, modulus]</tt> resulting
|
||||
* from dividing +self+ the given divisor.
|
||||
* - #fdiv: Returns the Float result of dividing +self+ by the given divisor.
|
||||
* - #floor: Returns the largest number less than or equal to +self+,
|
||||
* to a given precision.
|
||||
* - #i: Returns the Complex object <tt>Complex(0, self)</tt>.
|
||||
* the given value.
|
||||
* - #imaginary (aliased as #imag): Returns the imaginary part of the +self+.
|
||||
* - #numerator: Returns the numerator of the Rational representation of +self+;
|
||||
* has the same sign as +self+.
|
||||
* - #polar: Returns the array <tt>[self.abs, self.arg]</tt>.
|
||||
* - #quo: Returns the value of +self+ divided by the given value.
|
||||
* - #real: Returns the real part of +self+.
|
||||
* - #rect (aliased as #rectangular): Returns the array <tt>[self, 0]</tt>.
|
||||
* - #remainder: Returns <tt>self-arg*(self/arg).truncate</tt> for the given +arg+.
|
||||
* - #round: Returns the value of +self+ rounded to the nearest value
|
||||
* for the given a precision.
|
||||
* - #to_c: Returns the Complex representation of +self+.
|
||||
* - #to_int: Returns the Integer representation of +self+, truncating if necessary.
|
||||
* - #truncate: Returns +self+ truncated (toward zero) to a given precision.
|
||||
*
|
||||
* === Other
|
||||
*
|
||||
* - #clone:: Returns +self+; does not allow freezing.
|
||||
* - #dup (aliased as #+@):: Returns +self+.
|
||||
* - #step:: Invokes the given block with the sequence of specified numbers.
|
||||
* - #clone: Returns +self+; does not allow freezing.
|
||||
* - #dup (aliased as #+@): Returns +self+.
|
||||
* - #step: Invokes the given block with the sequence of specified numbers.
|
||||
*
|
||||
*/
|
||||
void
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue