Misc #17390
closedClass and method-level docs for Ractor
Description
GitHub PR: https://github.com/ruby/ruby/pull/3895
Copying from PR descriptioin:
Currently, ractors documented only by doc/ractor.md, which has a flavor of a design/discussion document. I wanted to establish some base documentation, which will allow to understand and use the concept immediately. Currently, Ractor class has no docs at all -- it is partially due to the fact that ractor.rb
is not included in the .document
list for RDoc, but even so, per-method docs in ractor.rb seem kinda sparse and chaotic to me.
I've completely rewritten the class docs. They are now somewhat duplicating doc/ractor.md
, but from a different perspective.
Test rendering of the docs on my personal site: Ractor.html
@ko1 (Koichi Sasada) @marcandre (Marc-Andre Lafortune) @Eregon (Benoit Daloze) Can you please review it?
And one question I couldn't clarify by myself: can somebody please show an example of the code throwing Ractor::UnsafeError
and maybe provide some brief explanation about it?.. From the sources I kinda get the idea, but my knowledge is not deep enough.
Updated by zverok (Victor Shepelev) almost 2 years ago
- Status changed from Open to Closed