diff options
| author | BurdetteLamar <burdettelamar@yahoo.com> | 2025-01-23 08:56:15 -0600 |
|---|---|---|
| committer | Peter Zhu <peter@peterzhu.ca> | 2025-01-24 10:44:24 -0500 |
| commit | 22e5d83cd1149b8f2a91ed489993ba952d35a9d8 (patch) | |
| tree | 7cf6df353a57f30d0e486604edd12da914f0a928 | |
| parent | f6e259da87433c2b2f89e395ce535f78521c7625 (diff) | |
[DOC] Tweaks for Hash.new
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/12620
| -rw-r--r-- | hash.rb | 10 |
1 files changed, 7 insertions, 3 deletions
@@ -4,8 +4,10 @@ class Hash # Hash.new(capacity: 0) {|self, key| ... } -> new_hash # # Returns a new empty \Hash object. + # # Initializes the values of Hash#default and Hash#default_proc, - # which determine the value to be returned by method Hash#[] when the entry does not exist. + # which determine the behavior when a given key is not found; + # see {Key Not Found?}[rdoc-ref:Hash@Key+Not+Found-3F]. # # By default, a hash has +nil+ values for both +default+ and +default_proc+: # @@ -13,19 +15,21 @@ class Hash # h.default # => nil # h.default_proc # => nil # - # If the +default_value+ argument is provided, it sets the +default+ value for the hash: + # With argument +default_value+ given, sets the +default+ value for the hash: # # h = Hash.new(false) # => {} # h.default # => false # h.default_proc # => nil # - # If a block is given, it sets the +default_proc+ value: + # With a block given, sets the +default_proc+ value: # # h = Hash.new {|hash, key| "Hash #{hash}: Default value for #{key}" } # h.default # => nil # h.default_proc # => #<Proc:0x00000289b6fa7048 (irb):185> # h[:nosuch] # => "Hash {}: Default value for nosuch" # + # Raises ArgumentError if both +default_value+ and a block are given. + # # If optional keyword argument +capacity+ is given with a positive integer value +n+, # initializes the hash with enough capacity to accommodate +n+ entries without resizing. # |
