1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Correct API documentation for ActionController::Parameters#delete

This commit is contained in:
Ryan Lue 2017-07-20 16:58:30 +08:00
parent 526d4b8dc8
commit d75d9da174

View file

@ -673,10 +673,10 @@ module ActionController
self
end
# Deletes and returns a key-value pair from +Parameters+ whose key is equal
# to key. If the key is not found, returns the default value. If the
# optional code block is given and the key is not found, pass in the key
# and return the result of block.
# Deletes a key-value pair from +Parameters+ and returns the value. If
# +key+ is not found, returns +nil+ (or, with optional code block, yields
# +key+ and returns the result). Cf. +#extract!+, which returns the
# corresponding +ActionController::Paramters+ object.
def delete(key, &block)
convert_value_to_parameters(@parameters.delete(key, &block))
end