ruby-changes:45662
From: stomar <ko1@a...>
Date: Tue, 28 Feb 2017 03:07:17 +0900 (JST)
Subject: [ruby-changes:45662] stomar:r57735 (trunk): Fix doc for Hash#dig and Struct#dig
stomar 2017-02-28 03:07:11 +0900 (Tue, 28 Feb 2017) New Revision: 57735 https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=57735 Log: Fix doc for Hash#dig and Struct#dig * hash.c (rb_hash_dig): [DOC] correct argument name in method description; fix formatting in examples. * struct.c (rb_struct_dig): ditto. [ruby-core:79221] [Bug #13148] Modified files: trunk/hash.c trunk/struct.c Index: struct.c =================================================================== --- struct.c (revision 57734) +++ struct.c (revision 57735) @@ -1130,15 +1130,15 @@ rb_struct_size(VALUE s) https://github.com/ruby/ruby/blob/trunk/struct.c#L1130 * call-seq: * struct.dig(key, ...) -> object * - * Extracts the nested value specified by the sequence of <i>idx</i> + * Extracts the nested value specified by the sequence of +key+ * objects by calling +dig+ at each step, returning +nil+ if any * intermediate step is +nil+. * * klass = Struct.new(:a) * o = klass.new(klass.new({b: [1, 2, 3]})) * - * o.dig(:a, :a, :b, 0) #=> 1 - * o.dig(:b, 0) #=> nil + * o.dig(:a, :a, :b, 0) #=> 1 + * o.dig(:b, 0) #=> nil */ static VALUE Index: hash.c =================================================================== --- hash.c (revision 57734) +++ hash.c (revision 57735) @@ -2862,19 +2862,19 @@ rb_hash_any_p(VALUE hash) https://github.com/ruby/ruby/blob/trunk/hash.c#L2862 * call-seq: * hsh.dig(key, ...) -> object * - * Extracts the nested value specified by the sequence of <i>idx</i> + * Extracts the nested value specified by the sequence of <i>key</i> * objects by calling +dig+ at each step, returning +nil+ if any * intermediate step is +nil+. * * h = { foo: {bar: {baz: 1}}} * - * h.dig(:foo, :bar, :baz) #=> 1 - * h.dig(:foo, :zot, :xyz) #=> nil + * h.dig(:foo, :bar, :baz) #=> 1 + * h.dig(:foo, :zot, :xyz) #=> nil * * g = { foo: [10, 11, 12] } - * g.dig(:foo, 1) #=> 11 - * g.dig(:foo, 1, 0) #=> TypeError: Integer does not have #dig method - * g.dig(:foo, :bar) #=> TypeError: no implicit conversion of Symbol into Integer + * g.dig(:foo, 1) #=> 11 + * g.dig(:foo, 1, 0) #=> TypeError: Integer does not have #dig method + * g.dig(:foo, :bar) #=> TypeError: no implicit conversion of Symbol into Integer */ VALUE -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/