Document `RactorLocalSingleton`
まだ誰も着手していません。
- 主要言語
- Ruby
- スター
- 33
- フォーク
- 9
- 平均マージ
- 14時間 52分
- マージ済み PR(30日)
- 1
説明
I was made aware of the RactorLocalSingleton class today. When I attempted to look it up in the Ruby docs, I was greeted with an empty page on both 3.4 and master:
- https://docs.ruby-lang.org/en/3.4/RactorLocalSingleton.html
- https://docs.ruby-lang.org/en/master/RactorLocalSingleton.html
It's not clear what the advice about when or whether to use this module is. I see that there is some discussion around the time the feature was implemented:
It would be nice if someone who designed this feature could clarify what the intended usage and possible limitations of this module are, so that the documentation gets published to the Ruby Documentation site.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず Ruby 3.4 と master の空の RactorLocalSingleton ページを確認し、その後、機能の背景を把握するために bugs.ruby-lang.org/issues/18127 と ruby/singleton#4 を読んでください。関連する設計上の背景を踏まえて想定される使用方法と制限事項を明確にし、Ruby Documentation サイトに有用なドキュメントが公開された時点で作業完了と考えてください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- ruby
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100