clarify returning_ combinator semantics

ocaml-multicore · Oct 28, 2022 · 5e460ad · 5e460ad
1 parent 7104612
commit 5e460ad
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/lib/lin_api.mli b/lib/lin_api.mli
@@ -197,12 +197,13 @@ val returning_or_exc :
     In either case the result is compared to the corresponding sequential result and hence [comb] has to be [deconstructible]. *)
 
 val returning_ : ('a, 'b, 'c, 'd) ty -> ('a, unit, 'c) Fun.fn
-(** [returning comb] indicates the return type [comb] which is ignored. *)
+(** [returning comb] indicates that the return type is [comb] and that it should
+    not be compared to the corresponding sequential result. *)
 
 val returning_or_exc_ :
   ('a, 'b, 'c, 'd) ty -> ('a, (unit, exn) result, 'c) Fun.fn
 (** [returning_or_exc comb] indicates that the function may raise an exception and that the return type is [comb].
-    In both cases the result is ignored. *)
+    In both cases the result is not compared to the corresponding sequential result. *)
 
 val ( @-> ) :
   ('a, constructible, 'b, 'c) ty ->