From efa4ec0f981ed51af82d32146f24158552eb2bd7 Mon Sep 17 00:00:00 2001 From: BurdetteLamar Date: Mon, 26 Aug 2024 14:33:22 +0100 Subject: [PATCH] [DOC] Tweaks to Array#delete --- array.c | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/array.c b/array.c index dca4464c59..49c8a59a48 100644 --- a/array.c +++ b/array.c @@ -3995,37 +3995,37 @@ ary_resize_smaller(VALUE ary, long len) /* * call-seq: - * array.delete(obj) -> deleted_object - * array.delete(obj) {|nosuch| ... } -> deleted_object or block_return + * delete(object) -> last_deleted_object + * delete(object) {|element| ... } -> last_deleted_object or block_return * * Removes zero or more elements from +self+. * - * When no block is given, - * removes from +self+ each element +ele+ such that ele == obj; + * With no block given, + * removes from +self+ each element +ele+ such that ele == object; * returns the last deleted element: * - * s1 = 'bar'; s2 = 'bar' - * a = [:foo, s1, 2, s2] - * a.delete('bar') # => "bar" - * a # => [:foo, 2] + * a = [0, 1, 2, 2.0] + * a.delete(2) # => 2.0 + * a # => [0, 1] * - * Returns +nil+ if no elements removed. + * Returns +nil+ if no elements removed: * - * When a block is given, - * removes from +self+ each element +ele+ such that ele == obj. + * a.delete(2) # => nil + * + * With a block given, + * removes from +self+ each element +ele+ such that ele == object. * * If any such elements are found, ignores the block * and returns the last deleted element: * - * s1 = 'bar'; s2 = 'bar' - * a = [:foo, s1, 2, s2] - * deleted_obj = a.delete('bar') {|obj| fail 'Cannot happen' } - * a # => [:foo, 2] + * a = [0, 1, 2, 2.0] + * a.delete(2) {|element| fail 'Cannot happen' } # => 2.0 + * a # => [0, 1] * - * If no such elements are found, returns the block's return value: + * If no such element is found, returns the block's return value: * - * a = [:foo, 'bar', 2] - * a.delete(:nosuch) {|obj| "#{obj} not found" } # => "nosuch not found" + * a.delete(2) {|element| "Element #{element} not found." } + * # => "Element 2 not found." * */