Add documentation for with_pipeline function

ocaml · Jun 9, 2024 · a321b53 · a321b53
1 parent 40046d6
commit a321b53
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ocaml-lsp-server/src/document.mli b/ocaml-lsp-server/src/document.mli
@@ -53,8 +53,13 @@ module Merlin : sig
 
   val timer : t -> Lev_fiber.Timer.Wheel.task
 
+  (** uses a single pipeline, provisioned by the configuration attached to the
+      merlin document (via {!type:t}). *)
   val with_pipeline_exn : ?name:string -> t -> (Mpipeline.t -> 'a) -> 'a Fiber.t
 
+  (** Like {!val:with_pipeline_exn} but where the merlin configuration is
+      supplied manually. If, for example, it is computed outside the execution
+      of the pipeline.*)
   val with_configurable_pipeline_exn :
     ?name:string -> config:Mconfig.t -> t -> (Mpipeline.t -> 'a) -> 'a Fiber.t