[ci skip] fix doc for the Hash#assert_valid_keys
This commit is contained in:
parent
f42f603d8a
commit
b81f364905
|
@ -57,9 +57,9 @@ class Hash
|
||||||
end
|
end
|
||||||
alias_method :to_options!, :symbolize_keys!
|
alias_method :to_options!, :symbolize_keys!
|
||||||
|
|
||||||
# Validate all keys in a hash match <tt>*valid_keys</tt>, raising ArgumentError
|
# Ensures all the hash's keys are present in the supplied list of <tt>*valid_keys</tt>.
|
||||||
# on a mismatch. Note that keys are NOT treated indifferently, meaning if you
|
# Raises an ArgumentError if any unexpected keys are encountered.
|
||||||
# use strings for keys but assert symbols as keys, this will fail.
|
# Note that keys are NOT treated indifferently: strings and symbols will not match each other.
|
||||||
#
|
#
|
||||||
# { 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'"
|
||||||
|
|
Loading…
Reference in New Issue