Document `RactorLocalSingleton`
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 33
- Forks
- 9
- Avg merge
- 14h 52m
- Merged PRs (30d)
- 1
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the empty RactorLocalSingleton pages for Ruby 3.4 and master, then read bugs.ruby-lang.org/issues/18127 and ruby/singleton#4 for the feature context. Clarify the intended usage and limitations with the relevant design context, and consider the work done when useful documentation is published to the Ruby Documentation site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100