From 6b82ba9e26c856ef9b479164a034e428725f11df Mon Sep 17 00:00:00 2001 From: stomar Date: Mon, 27 Feb 2017 18:07:11 +0000 Subject: [PATCH] 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] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57735 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- hash.c | 12 ++++++------ struct.c | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/hash.c b/hash.c index 4b76d0282f..3b2b6c61ca 100644 --- a/hash.c +++ b/hash.c @@ -2862,19 +2862,19 @@ rb_hash_any_p(VALUE hash) * call-seq: * hsh.dig(key, ...) -> object * - * Extracts the nested value specified by the sequence of idx + * 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+. * * 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 diff --git a/struct.c b/struct.c index 77b81b45ac..745d2800ed 100644 --- a/struct.c +++ b/struct.c @@ -1130,15 +1130,15 @@ rb_struct_size(VALUE s) * call-seq: * struct.dig(key, ...) -> object * - * Extracts the nested value specified by the sequence of idx + * 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