Fix documentation from #15669 [ci skip]

This commit is contained in:
Zachary Scott 2014-06-17 14:13:02 -07:00
parent b81f364905
commit 9f86780226
1 changed files with 5 additions and 3 deletions

View File

@ -57,9 +57,11 @@ class Hash
end end
alias_method :to_options!, :symbolize_keys! alias_method :to_options!, :symbolize_keys!
# Ensures all the hash's keys are present in the supplied list of <tt>*valid_keys</tt>. # Validate all keys in a hash match <tt>*valid_keys</tt>, raising
# Raises an ArgumentError if any unexpected keys are encountered. # ArgumentError on a mismatch.
# Note that keys are NOT treated indifferently: strings and symbols will not match each other. #
# Note that keys are treated differently than HashWithIndifferentAccess,
# meaning that string and symbol keys will not match.
# #
# { name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: :years. Valid keys are: :name, :age" # { name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: :years. Valid keys are: :name, :age"
# { name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: :name. Valid keys are: 'name', 'age'" # { name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: :name. Valid keys are: 'name', 'age'"