Fix typos and grammar errors in kernel.rb

This commit is contained in:
Stan Lo 2024-11-19 23:30:30 +00:00 committed by Hiroshi SHIBATA
parent a208ac6f4b
commit 86b1c83857
Notes: git 2024-11-20 02:05:12 +00:00

View File

@ -73,7 +73,7 @@ module Kernel
# call-seq: # call-seq:
# obj.tap {|x| block } -> obj # obj.tap {|x| block } -> obj
# #
# Yields self to the block, and then returns self. # Yields self to the block and then returns self.
# The primary purpose of this method is to "tap into" a method chain, # The primary purpose of this method is to "tap into" a method chain,
# in order to perform operations on intermediate results within the chain. # in order to perform operations on intermediate results within the chain.
# #
@ -100,7 +100,7 @@ module Kernel
# #
# 3.next.then {|x| x**x }.to_s #=> "256" # 3.next.then {|x| x**x }.to_s #=> "256"
# #
# Good usage for +then+ is value piping in method chains: # A good use of +then+ is value piping in method chains:
# #
# require 'open-uri' # require 'open-uri'
# require 'json' # require 'json'
@ -109,13 +109,13 @@ module Kernel
# .then {|url| URI(url).read } # .then {|url| URI(url).read }
# .then {|response| JSON.parse(response) } # .then {|response| JSON.parse(response) }
# #
# When called without block, the method returns +Enumerator+, # When called without a block, the method returns an +Enumerator+,
# which can be used, for example, for conditional # which can be used, for example, for conditional
# circuit-breaking: # circuit-breaking:
# #
# # meets condition, no-op # # Meets condition, no-op
# 1.then.detect(&:odd?) # => 1 # 1.then.detect(&:odd?) # => 1
# # does not meet condition, drop value # # Does not meet condition, drop value
# 2.then.detect(&:odd?) # => nil # 2.then.detect(&:odd?) # => nil
# #
def then def then
@ -145,7 +145,7 @@ module Kernel
# # ... # # ...
# end # end
# #
# StopIteration raised in the block breaks the loop. In this case, # A StopIteration raised in the block breaks the loop. In this case,
# loop returns the "result" value stored in the exception. # loop returns the "result" value stored in the exception.
# #
# enum = Enumerator.new { |y| # enum = Enumerator.new { |y|
@ -178,9 +178,9 @@ module Kernel
# #
# Returns <i>arg</i> converted to a float. Numeric types are # Returns <i>arg</i> converted to a float. Numeric types are
# converted directly, and with exception to String and # converted directly, and with exception to String and
# <code>nil</code> the rest are converted using # <code>nil</code>, the rest are converted using
# <i>arg</i><code>.to_f</code>. Converting a String with invalid # <i>arg</i><code>.to_f</code>. Converting a String with invalid
# characters will result in a ArgumentError. Converting # characters will result in an ArgumentError. Converting
# <code>nil</code> generates a TypeError. Exceptions can be # <code>nil</code> generates a TypeError. Exceptions can be
# suppressed by passing <code>exception: false</code>. # suppressed by passing <code>exception: false</code>.
# #
@ -210,22 +210,22 @@ module Kernel
# With a non-zero +base+, +object+ must be a string or convertible # With a non-zero +base+, +object+ must be a string or convertible
# to a string. # to a string.
# #
# ==== numeric objects # ==== \Numeric objects
# #
# With integer argument +object+ given, returns +object+: # With an integer argument +object+ given, returns +object+:
# #
# Integer(1) # => 1 # Integer(1) # => 1
# Integer(-1) # => -1 # Integer(-1) # => -1
# #
# With floating-point argument +object+ given, # With a floating-point argument +object+ given,
# returns +object+ truncated to an integer: # returns +object+ truncated to an integer:
# #
# Integer(1.9) # => 1 # Rounds toward zero. # Integer(1.9) # => 1 # Rounds toward zero.
# Integer(-1.9) # => -1 # Rounds toward zero. # Integer(-1.9) # => -1 # Rounds toward zero.
# #
# ==== string objects # ==== \String objects
# #
# With string argument +object+ and zero +base+ given, # With a string argument +object+ and zero +base+ given,
# returns +object+ converted to an integer in base 10: # returns +object+ converted to an integer in base 10:
# #
# Integer('100') # => 100 # Integer('100') # => 100
@ -235,7 +235,7 @@ module Kernel
# to specify the actual base (radix indicator): # to specify the actual base (radix indicator):
# #
# Integer('0100') # => 64 # Leading '0' specifies base 8. # Integer('0100') # => 64 # Leading '0' specifies base 8.
# Integer('0b100') # => 4 # Leading '0b', specifies base 2. # Integer('0b100') # => 4 # Leading '0b' specifies base 2.
# Integer('0x100') # => 256 # Leading '0x' specifies base 16. # Integer('0x100') # => 256 # Leading '0x' specifies base 16.
# #
# With a positive +base+ (in range 2..36) given, returns +object+ # With a positive +base+ (in range 2..36) given, returns +object+
@ -246,8 +246,8 @@ module Kernel
# Integer('-100', 16) # => -256 # Integer('-100', 16) # => -256
# #
# With a negative +base+ (in range -36..-2) given, returns +object+ # With a negative +base+ (in range -36..-2) given, returns +object+
# converted to an integer in the radix indicator if exists or # converted to the radix indicator if it exists or
# +-base+: # +base+:
# #
# Integer('0x100', -2) # => 256 # Integer('0x100', -2) # => 256
# Integer('100', -2) # => 4 # Integer('100', -2) # => 4
@ -256,7 +256,7 @@ module Kernel
# Integer('0o100', -10) # => 64 # Integer('0o100', -10) # => 64
# Integer('100', -10) # => 100 # Integer('100', -10) # => 100
# #
# +base+ -1 is equal the -10 case. # +base+ -1 is equivalent to the -10 case.
# #
# When converting strings, surrounding whitespace and embedded underscores # When converting strings, surrounding whitespace and embedded underscores
# are allowed and ignored: # are allowed and ignored:
@ -264,7 +264,7 @@ module Kernel
# Integer(' 100 ') # => 100 # Integer(' 100 ') # => 100
# Integer('-1_0_0', 16) # => -256 # Integer('-1_0_0', 16) # => -256
# #
# ==== other classes # ==== Other classes
# #
# Examples with +object+ of various other classes: # Examples with +object+ of various other classes:
# #
@ -272,26 +272,26 @@ module Kernel
# Integer(Complex(2, 0)) # => 2 # Imaginary part must be zero. # Integer(Complex(2, 0)) # => 2 # Imaginary part must be zero.
# Integer(Time.now) # => 1650974042 # Integer(Time.now) # => 1650974042
# #
# ==== keywords # ==== Keywords
# #
# With optional keyword argument +exception+ given as +true+ (the default): # With the optional keyword argument +exception+ given as +true+ (the default):
# #
# - Raises TypeError if +object+ does not respond to +to_int+ or +to_i+. # - Raises TypeError if +object+ does not respond to +to_int+ or +to_i+.
# - Raises TypeError if +object+ is +nil+. # - Raises TypeError if +object+ is +nil+.
# - Raise ArgumentError if +object+ is an invalid string. # - Raises ArgumentError if +object+ is an invalid string.
# #
# With +exception+ given as +false+, an exception of any kind is suppressed # With +exception+ given as +false+, an exception of any kind is suppressed
# and +nil+ is returned. # and +nil+ is returned.
#
def Integer(arg, base = 0, exception: true) def Integer(arg, base = 0, exception: true)
if Primitive.mandatory_only? if Primitive.mandatory_only?
Primitive.rb_f_integer1(arg) Primitive.rb_f_integer1(arg)
else else
Primitive.rb_f_integer(arg, base, exception); Primitive.rb_f_integer(arg, base, exception)
end end
end end
# Internal helper for builtin inits to define methods only when YJIT is enabled. # Internal helper for built-in initializations to define methods only when YJIT is enabled.
# This method is removed in yjit_hook.rb. # This method is removed in yjit_hook.rb.
def with_yjit(&block) # :nodoc: def with_yjit(&block) # :nodoc:
if defined?(RubyVM::YJIT) if defined?(RubyVM::YJIT)