Project

General

Profile

Misc #15529

Document Enumerator::Lazy

Added by zverok (Victor Shepelev) 9 months ago. Updated 7 months ago.

Status:
Closed
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

Associated revisions

Revision f2ea705d
Added by hsbt (Hiroshi SHIBATA) 7 months ago

Add Enumerator::Lazy docs.

  • explanation of the class concept, with examples;
  • docs for all class methods (most of them just say "Like Enumerable#, 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.

[Misc #15529][ruby-core:91046]

Co-authored-by: zverok zverok.offline@gmail.com

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@67320 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 67320
Added by hsbt (Hiroshi SHIBATA) 7 months ago

Add Enumerator::Lazy docs.

  • explanation of the class concept, with examples;
  • docs for all class methods (most of them just say "Like Enumerable#, 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.

[Misc #15529][ruby-core:91046]

Co-authored-by: zverok zverok.offline@gmail.com

History

#1

Updated by hsbt (Hiroshi SHIBATA) 7 months ago

  • Status changed from Open to Closed

Applied in changeset trunk|r67320.


Add Enumerator::Lazy docs.

  • explanation of the class concept, with examples;
  • docs for all class methods (most of them just say "Like Enumerable#, 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.

[Misc #15529][ruby-core:91046]

Co-authored-by: zverok zverok.offline@gmail.com

Also available in: Atom PDF