Add Enumerator::Yielder documentation #2273
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enumerator::Yielderのドキュメントを追加します。
このクラスは
Enumerator.new
からのみ使われるべきものなので、クラスの説明にも「直接使うものではありません」と書いています。#1141
ただ、説明がないと
Enumerator.new
から使う時に迷ってしまうと思うので、ドキュメントを書くことは必要だと思っています。また、合わせて Ruby 2.7で追加された
Enumerator::Yielder.to_proc
のドキュメントも書いています。 #2071RDoc: https://docs.ruby-lang.org/en/2.7.0/Enumerator/Yielder.html#method-i-to_proc
RDocでは
<<
とyield
メソッドのドキュメントがありませんが、このドキュメントがないとEnumerator.new
からどうやって使うべきか分かりづらいなと思ったので、あえて書きました。ruby-jp slackの方で多少議論をしたので貼っておきます。