diff options
| author | Seba Gamboa <[email protected]> | 2015-10-20 12:48:31 -0300 |
|---|---|---|
| committer | Seba Gamboa <[email protected]> | 2015-10-20 12:48:31 -0300 |
| commit | 13b552538af9e9794398e4a4177ba1cea04cccca (patch) | |
| tree | a4c682a8750401876eebc7ede793a6ca1ad70fd5 /mrbgems/mruby-enum-ext | |
| parent | f0e997422137e9fc92923a49465f009b2730e78d (diff) | |
| download | mruby-13b552538af9e9794398e4a4177ba1cea04cccca.tar.gz mruby-13b552538af9e9794398e4a4177ba1cea04cccca.zip | |
Remove obvious warnings from docs
Diffstat (limited to 'mrbgems/mruby-enum-ext')
| -rw-r--r-- | mrbgems/mruby-enum-ext/mrblib/enum.rb | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/mrbgems/mruby-enum-ext/mrblib/enum.rb b/mrbgems/mruby-enum-ext/mrblib/enum.rb index 7efec89c9..b41eaaf1f 100644 --- a/mrbgems/mruby-enum-ext/mrblib/enum.rb +++ b/mrbgems/mruby-enum-ext/mrblib/enum.rb @@ -78,10 +78,10 @@ module Enumerable # Passes elements to the block until the block returns +nil+ or +false+, # then stops iterating and returns an array of all prior elements. # - # If no block is given, an enumerator is returned instead. + # If no block is given, an enumerator is returned instead. # - # a = [1, 2, 3, 4, 5, 0] - # a.take_while {|i| i < 3 } #=> [1, 2] + # a = [1, 2, 3, 4, 5, 0] + # a.take_while {|i| i < 3 } #=> [1, 2] # # @mrbgem mruby-enum-ext def take_while(&block) @@ -96,13 +96,12 @@ module Enumerable end ## - # call-seq: - # enum.each_cons(n) {...} -> nil - # # Iterates the given block for each array of consecutive <n> # elements. # - # e.g.: + # @return [nil] + # + # @example # (1..10).each_cons(3) {|a| p a} # # outputs below # [1, 2, 3] @@ -130,12 +129,11 @@ module Enumerable end ## - # call-seq: - # enum.each_slice(n) {...} -> nil - # # Iterates the given block for each slice of <n> elements. # - # e.g.: + # @return [nil] + # + # @example # (1..10).each_slice(3) {|a| p a} # # outputs below # [1, 2, 3] @@ -170,7 +168,7 @@ module Enumerable # block, and values are arrays of elements in <i>enum</i> # corresponding to the key. # - # (1..6).group_by {|i| i%3} #=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]} + # (1..6).group_by {|i| i%3} #=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]} # # @mrbgem mruby-enum-ext def group_by(&block) |
