Document `RactorLocalSingleton`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Ruby
- Sterne
- 33
- Forks
- 9
- Ø Merge
- 14 Std. 52 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die leeren RactorLocalSingleton-Seiten für Ruby 3.4 und master zu prüfen, und lies anschließend bugs.ruby-lang.org/issues/18127 und ruby/singleton#4, um den Kontext des Features zu verstehen. Kläre die beabsichtigte Verwendung und die Einschränkungen anhand des relevanten Designkontexts und betrachte die Arbeit als abgeschlossen, wenn nützliche Dokumentation auf der Ruby Documentation-Website veröffentlicht wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100