archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Documentation improvements for Ruby core

Browse source 
* Top-level `return`;
* Documentation for comments syntax;
* `rescue` inside blocks;
* Enhance `Object#to_enum` docs;
* Make `chomp:` option more obvious for `String#each_line` and
  `#lines`;
* Enhance `Proc#>>` and `#<<` docs;
* Enhance `Processs` class docs.
This commit is contained in:
zverok 2019-10-24 19:35:36 +03:00 • committed by Nobuyoshi Nakada
parent cf9344131c
commit bddb31bb37
Notes: git 2019-10-26 14:58:35 +09:00
8 changed files with 118 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

8
enumerator.c
View file

@ -295,7 +295,8 @@ proc_entry_ptr(VALUE proc_entry)
* obj.enum_for(method = :each, *args){|*args| block} -> enum
*
* Creates a new Enumerator which will enumerate by calling +method+ on
* +obj+, passing +args+ if any.
* +obj+, passing +args+ if any. What was _yielded_ by method becomes
* values of enumerator.
*
* If a block is given, it will be used to calculate the size of
* the enumerator without the need to iterate it (see Enumerator#size).
@ -314,6 +315,11 @@ proc_entry_ptr(VALUE proc_entry)
* a = [1, 2, 3]
* some_method(a.to_enum)
*
* # String#split in block form is more memory-effective:
* very_large_string.to_enum(:split, "|") { |chunk| return chunk if chunk.include?('DATE') }
* # This could be rewritten more idiomatically with to_enum:
* very_large_string.to_enum(:split, "|").lazy.grep(/DATE/).first
*
* It is typical to call to_enum when defining methods for
* a generic Enumerable, in case no block is passed.
*