kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Fix doc for Hash#dig and Struct#dig

Browse source 
* 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
This commit is contained in:
stomar 2017-02-27 18:07:11 +00:00
parent 6d3654d59b
commit 6b82ba9e26
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
hash.c
View file

@ -2862,19 +2862,19 @@ rb_hash_any_p(VALUE hash)
* call-seq: * call-seq:
* hsh.dig(key, ...) -> object * 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 * objects by calling +dig+ at each step, returning +nil+ if any
* intermediate step is +nil+. * intermediate step is +nil+.
* *
* h = { foo: {bar: {baz: 1}}} * h = { foo: {bar: {baz: 1}}}
* *
* h.dig(:foo, :bar, :baz) #=> 1 * h.dig(:foo, :bar, :baz) #=> 1
* h.dig(:foo, :zot, :xyz) #=> nil * h.dig(:foo, :zot, :xyz) #=> nil
* *
* g = { foo: [10, 11, 12] } * g = { foo: [10, 11, 12] }
* g.dig(:foo, 1) #=> 11 * g.dig(:foo, 1) #=> 11
* g.dig(:foo, 1, 0) #=> TypeError: Integer does not have #dig method * 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, :bar) #=> TypeError: no implicit conversion of Symbol into Integer
*/ */
VALUE VALUE

6
struct.c
View file

@ -1130,15 +1130,15 @@ rb_struct_size(VALUE s)
* call-seq: * call-seq:
* struct.dig(key, ...) -> object * 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 * objects by calling +dig+ at each step, returning +nil+ if any
* intermediate step is +nil+. * intermediate step is +nil+.
* *
* klass = Struct.new(:a) * klass = Struct.new(:a)
* o = klass.new(klass.new({b: [1, 2, 3]})) * o = klass.new(klass.new({b: [1, 2, 3]}))
* *
* o.dig(:a, :a, :b, 0) #=> 1 * o.dig(:a, :a, :b, 0) #=> 1
* o.dig(:b, 0) #=> nil * o.dig(:b, 0) #=> nil
*/ */
static VALUE static VALUE