Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enumerator::Generator と Enumerator::Yielder がない #1141

Open
znz opened this issue Mar 17, 2018 · 2 comments
Open

Enumerator::Generator と Enumerator::Yielder がない #1141

znz opened this issue Mar 17, 2018 · 2 comments

Comments

@znz
Copy link
Member

znz commented Mar 17, 2018

https://docs.ruby-lang.org/ja/latest/class/Enumerator.html の説明や https://docs.ruby-lang.org/ja/latest/class/Enumerator=3a=3aLazy.html の例に出てくるのに、クラス自体のドキュメントがありません。

メトッドがほぼないようなクラスでも、例外のクラスはメソッドなしでも追加されている、という例があるので、追加される方が良いと思います。

@znz
Copy link
Member Author

znz commented Apr 24, 2018

refm/api/src/_builtin/Enumerator の末尾に

#@# 以下のクラスはユーザが直接触れるべきではないのでドキュメントは
#@# 書かない
#@# = class Enumerator::Generator
#@# = class Enumerator::Yielder

とありました。
rdoc の方で nodoc になっていなくて、クラスのページ自体は存在して説明はない状態なので、こちらでは、「Enumerator.new で使われるクラスで、直接使うものではありません。」ぐらいの軽い説明をつけると良いのではないかと思いました。

@pocke
Copy link
Member

pocke commented May 24, 2020

Yielderのドキュメントを書きました。 #2273

Generator の方はよく分かってないので手を付けていません。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants