1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Related for Array#cycle

Browse Source
This commit is contained in:
BurdetteLamar 2024-09-09 09:45:50 -05:00 committed by Peter Zhu
parent a055a426ed
commit 7ec51310d5
Notes: git 2024-09-10 19:37:59 +00:00 
Merged: https://github.com/ruby/ruby/pull/11577
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
array.c
View File

@ -6815,7 +6815,7 @@ rb_ary_cycle_size(VALUE self, VALUE args, VALUE eobj)
* {integer-convertible object}[rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects], * {integer-convertible object}[rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects],
* or +nil+. * or +nil+.
* *
* If +count+ is positive, * When +count+ is positive,
* calls the block with each element, then does so repeatedly, * calls the block with each element, then does so repeatedly,
* until it has done so +count+ times; returns +nil+: * until it has done so +count+ times; returns +nil+:
* *
@ -6823,18 +6823,20 @@ rb_ary_cycle_size(VALUE self, VALUE args, VALUE eobj)
* [0, 1].cycle(2) {|element| output.push(element) } # => nil * [0, 1].cycle(2) {|element| output.push(element) } # => nil
* output # => [0, 1, 0, 1] * output # => [0, 1, 0, 1]
* *
* If +count+ is zero or negative, does not call the block: * When +count+ is zero or negative, does not call the block:
* *
* [0, 1].cycle(0) {|element| fail 'Cannot happen' } # => nil * [0, 1].cycle(0) {|element| fail 'Cannot happen' } # => nil
* [0, 1].cycle(-1) {|element| fail 'Cannot happen' } # => nil * [0, 1].cycle(-1) {|element| fail 'Cannot happen' } # => nil
* *
* If +count+ is +nil+, cycles forever: * When +count+ is +nil+, cycles forever:
* *
* # Prints 0 and 1 forever. * # Prints 0 and 1 forever.
* [0, 1].cycle {|element| puts element } * [0, 1].cycle {|element| puts element }
* [0, 1].cycle(nil) {|element| puts element } * [0, 1].cycle(nil) {|element| puts element }
* *
* With no block given, returns a new Enumerator. * With no block given, returns a new Enumerator.
*
* Related: see {Methods for Iterating}[rdoc-ref:Array@Methods+for+Iterating].
*/ */
static VALUE static VALUE
rb_ary_cycle(int argc, VALUE *argv, VALUE ary) rb_ary_cycle(int argc, VALUE *argv, VALUE ary)