mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Merge pull request #21087 from vngrs/fix_hash_except_doc
Fix the documentation of Hash#except method [ci skip]
This commit is contained in:
commit
351d62e0e8
1 changed files with 9 additions and 8 deletions
|
@ -1,8 +1,9 @@
|
|||
class Hash
|
||||
# Returns a hash that includes everything but the given keys.
|
||||
# hash = { a: true, b: false, c: nil}
|
||||
# hash.except(:c) # => { a: true, b: false}
|
||||
# hash # => { a: true, b: false, c: nil}
|
||||
# Returns a hash that includes everything except given keys.
|
||||
# hash = { a: true, b: false, c: nil }
|
||||
# hash.except(:c) # => { a: true, b: false }
|
||||
# hash.except(:a, :b) # => { c: nil }
|
||||
# hash # => { a: true, b: false, c: nil }
|
||||
#
|
||||
# This is useful for limiting a set of parameters to everything but a few known toggles:
|
||||
# @person.update(params[:person].except(:admin))
|
||||
|
@ -10,10 +11,10 @@ class Hash
|
|||
dup.except!(*keys)
|
||||
end
|
||||
|
||||
# Replaces the hash without the given keys.
|
||||
# hash = { a: true, b: false, c: nil}
|
||||
# hash.except!(:c) # => { a: true, b: false}
|
||||
# hash # => { a: true, b: false }
|
||||
# Removes the given keys from hash and returns it.
|
||||
# hash = { a: true, b: false, c: nil }
|
||||
# hash.except!(:c) # => { a: true, b: false }
|
||||
# hash # => { a: true, b: false }
|
||||
def except!(*keys)
|
||||
keys.each { |key| delete(key) }
|
||||
self
|
||||
|
|
Loading…
Reference in a new issue