Skip to content

Commit 8aa299d

Browse files
committed
Tweak magic comments [doc]
1 parent 8c510e4 commit 8aa299d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/syntax/comments.rdoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -178,22 +178,22 @@ In this mode, all values assigned to constants are made shareable.
178178
X = var # => calls `Ractor.make_shareable(var)`
179179
var.frozen? # => true
180180

181-
This mode is "experimental", because it might be error prone, for
182-
example by deep-freezing the constants of an external resource which
181+
This mode is "experimental", because it might be error prone, for
182+
example by deep-freezing the constants of an external resource which
183183
could cause errors:
184184

185185
# shareable_constant_value: experimental_everything
186186
FOO = SomeGem::Something::FOO
187187
# => deep freezes the gem's constant!
188188

189-
We will revisit to consider removing "experimental_" or removing this
190-
mode by checking usages before Ruby 3.1.
189+
This will be revisited before Ruby 3.1 to either allow `everything`
190+
or to instead remove this mode.
191191

192192
The method Module#const_set is not affected.
193193

194194
==== Mode +experimental_copy+
195195

196-
In this mode, all values assigned to constants are copyied deeply and
196+
In this mode, all values assigned to constants are deeply copied and
197197
made shareable. It is safer mode than +experimental_everything+.
198198

199199
# shareable_constant_value: experimental_everything
@@ -204,9 +204,9 @@ made shareable. It is safer mode than +experimental_everything+.
204204
Ractor.shareable?(X) #=> true
205205
var.object_id == X.object_id #=> false
206206

207-
This mode is "experimental", because it is not discussed enough.
208-
We will revisit to consider removing "experimental_" or removing this
209-
mode by checking usages before Ruby 3.1.
207+
This mode is "experimental" and has not been discussed thoroughly.
208+
This will be revisited before Ruby 3.1 to either allow `copy`
209+
or to instead remove this mode.
210210

211211
The method Module#const_set is not affected.
212212

@@ -224,7 +224,7 @@ This directive can be used multiple times in the same file:
224224
B.frozen? # => true
225225
B[:foo].frozen? # => true
226226

227-
C = [Object.new] # => cannot assign unshareable object to C (Ractor::Error)
227+
C = [Object.new] # => cannot assign unshareable object to C (Ractor::IsolationError)
228228

229229
D = [Object.new.freeze]
230230
D.frozen? # => true

0 commit comments

Comments
 (0)