Skip to content

Commit f90522f

Browse files
committed
Tweak
1 parent 47e0188 commit f90522f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/Multicore_magic.mli

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,17 +202,19 @@ module Atomic_array : sig
202202

203203
val unsafe_fenceless_get : 'a t -> int -> 'a
204204
(** [unsafe_fenceless_get atomic_array index] reads and returns the value at
205-
the specified [index] of the [atomic_array] at some point. The read is {i
206-
relaxed} and may be reordered with respect to other reads and writes in
207-
program order.
205+
the specified [index] of the [atomic_array].
206+
207+
⚠️ The read is {i relaxed} and may be reordered with respect to other reads
208+
and writes in program order.
208209
209210
⚠️ No bounds checking is performed. *)
210211

211212
val unsafe_fenceless_set : 'a t -> int -> 'a -> unit
212213
(** [unsafe_fenceless_set atomic_array index value] writes the given [value]
213-
to the specified [index] of the [atomic_array]. The write is {i relaxed}
214-
and may be reordered with respect to other reads and (non-initializing)
215-
writes in program order.
214+
to the specified [index] of the [atomic_array].
215+
216+
⚠️ The write is {i relaxed} and may be reordered with respect to other
217+
reads and (non-initializing) writes in program order.
216218
217219
⚠️ No bounds checking is performed. *)
218220

0 commit comments

Comments
 (0)