diff --git a/src/saturn.mli b/src/saturn.mli index 657630af..88b4a703 100644 --- a/src/saturn.mli +++ b/src/saturn.mli @@ -53,14 +53,16 @@ Copyright (c) 2017, Nicolas ASSOUAD (** {2 Unsafe Data Structures} - Some data structures have both a normal and an {b unsafe} version. The - {b unsafe} version uses `Obj.magic`, which may be unsafe with flambda2 - optimizations. - - The unsafe version is provided because certain optimizations require features - not currently available in OCaml, such as arrays of atomics or atomic fields - in records. It is recommended to use the normal version unless performance - requirements necessitate the unsafe version. *) + Some data structures have both a normal and an {b unsafe} version. The + {b unsafe} version uses `Obj.magic`, which can be unsafe, especially with + flambda2 optimizations. + + The unsafe version is provided to explore performance optimizations that + require features not currently available in OCaml, such as arrays of atomics + or atomic fields in records. These versions give an indication of the + potential performance improvements when such features become available. + It is recommended to use the normal version unless the performance + requirements justify the risks associated with the unsafe version. *) (** {1 Data structures} *)