Skip to content

Commit 68b9c89

Browse files
committed
Note on compatibility with Stdlib.Atomic
1 parent 2b516ad commit 68b9c89

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/kcas/kcas.mli

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,11 @@ end
170170
{!Timeout.Timeout} exception may be raised by the operation to signal that
171171
the timeout expired. *)
172172

173-
(** Shared memory locations. *)
173+
(** Shared memory locations.
174+
175+
This module is essentially compatible with the [Stdlib.Atomic] module,
176+
except that a number of functions take some optional arguments that one
177+
usually need not worry about. *)
174178
module Loc : sig
175179
(** Type of shared memory locations. *)
176180
type !'a t =

0 commit comments

Comments
 (0)