Documentation.

ocaml-multicore · Oct 31, 2024 · b97bdb5 · b97bdb5
1 parent 6648196
commit b97bdb5
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src_lockfree/bounded_stack.mli b/src_lockfree/bounded_stack.mli
@@ -1,6 +1,10 @@
 (** Lock-free bounded stack. 
 
-  This module implements a lock-free bounded stack based on Treiber's stack algorithm. Adding a capacity to this algorithm adds a general overhead to the operations, and thus, it is recommended to use the unbounded stack {!Saturn_lockfree.Stack} if neither the capacity nor the {!length} function is needed.
+  This module implements a lock-free bounded stack based on Treiber's stack 
+  algorithm. Adding a capacity to this algorithm adds a general overhead to the
+   operations, and thus, it is recommended to use the unbounded stack 
+   {!Saturn_lockfree.Stack} if neither the capacity nor the {!length} function 
+    is needed.
 *)
 
 (** {1 API} *)