Project

General

Profile

Misc #15529

Document Enumerator::Lazy

Added by zverok (Victor Shepelev) about 1 month ago.

Status:
Open
Priority:
Normal
Assignee:
-
[ruby-core:91046]

Description

In this patch:

  • explanation of the class concept, with examples;
  • docs for all class methods (most of them just say "Like Enumerable#<methodname>, but chains operation to be lazy-evaluated.", but I believe they are useful this way because now have proper call-sequences and link to corresponding Enumerable's explanations)
  • simplified example for ::new to emphasize the main concept
  • Enumerable#lazy docs are slightly lightened and linked to this class for more in-depth explanations.

For the reference, currently class docs are looking like this: https://ruby-doc.org/core-2.6/Enumerator/Lazy.html


Files

document-enumerator-lazy.patch (11.4 KB) document-enumerator-lazy.patch zverok (Victor Shepelev), 01/12/2019 02:20 PM

Also available in: Atom PDF