doctree
doctree copied to clipboard
記述が不十分な箇所を加筆する
いくつか記述が無い箇所や不十分な箇所を見つけたのでこちらのIssueでリスト化し、それぞれの加筆の協力を募りたいと思います。まだ挙げられていない箇所があった場合はコメントに書いて頂けるとこちらで追記したいと思いますのでよろしくお願いします。
-
オブジェクト (Ruby 3.1 リファレンスマニュアル)
- [ ] モジュール
-
クラス (Ruby 3.1 リファレンスマニュアル)
- [ ] モジュール
- [ ] 特異クラス
-
Ruby プログラムの実行 (Ruby 3.1 リファレンスマニュアル)
- [ ] until
- [ ] if 修飾子
- [ ] unless 修飾子
- [ ] while
- [ ] until 修飾子
- [ ] for
- [ ] begin 〜 end
- [ ] eval, instance_eval, module_eval
- [ ] 多重代入
-
スレッド (Ruby 3.1 リファレンスマニュアル)
- [ ] デッドロックの検出
雑感です。
https://github.com/rurema/doctree/blob/7dcae13e1f03f4eb712ccafcaae029621625eec4/refm/doc/spec/eval.rd#L19-L23
るりまのページ、untilが2回でてますけど、並びから見て最初のはunlessの間違いですね。
if修飾子という単語より、後置ifの方が一般的で読み馴染みがあると思うので、 カッコ書きなどで別の表現があることがわかるようにすると親切そうだなと思いました。
全体を読んだり個別のメソッドページを見たわけではないですけど、 eval, instance_eval, module_evalは、メソッドへのリンクを貼って誘導すれば十分なのではないかと思いました
「Rubyプログラムの実行」のところの記述がない箇所も、制御構造の記述を読めば十分なんじゃないかと推測しています。 加筆をするというより、リンクを貼ったり、削除で良いのではないかと思ってます。
個人的に思うのは、加筆が進まないなら、 いっそのことページや項目を丸っと削除した方がいいのでは感じています。
例えば、「クラス」のページとか内容がほぼなく読まれてない気もし、他のページの説明で十分なのかなと思ったり思わなかったり。