basic docstrings

src/blocking_IO.mli

@@ -1,4 +1,4 @@
-(** {1 Blocking IO with a new thread for each [spawn]} *)
+(** Blocking IO with a new thread for each [spawn]. *)
 
 include
   Sigs.IO

src/dune

@@ -1,5 +1,6 @@
 (library
  (name linol)
  (public_name linol)
+ (private_modules log)
  (flags :standard -warn-error -a+8)
  (libraries yojson lsp logs threads))

src/jsonrpc2.ml

@@ -1,6 +1,3 @@
-(** {1 Simple JSON-RPC2 implementation}
-    See {{: https://www.jsonrpc.org/specification} the spec} *)
-
 module J = Yojson.Safe
 module Err = Jsonrpc.Response.Error
 

src/jsonrpc2.mli

@@ -1,3 +1,7 @@
+(** Simple JSON-RPC2 implementation.
+
+    See {{: https://www.jsonrpc.org/specification} the spec} *)
+
 type json = Yojson.Safe.t
 
 module type IO = Sigs.IO

src/linol.ml

@@ -1,4 +1,4 @@
-(** {1 Linol}
+(** Linol.
 
     Abstraction over The "Lsp" library, to make it easier to develop
     LSP servers in OCaml (but not necessarily {b for} OCaml). *)

src/server.ml

@@ -1,3 +1,5 @@
+(** Server interface *)
+
 open Sigs
 
 type nonrec doc_state = {
@@ -8,9 +10,9 @@ type nonrec doc_state = {
 }
 (** Current state of a document. *)
 
-(** {2 Request ID}
+(** Request ID.
 
-    unique ID of a request, used by JSONRPC to map each request to its reply. *)
+    The unique ID of a request, used by JSONRPC to map each request to its reply. *)
 module Req_id = struct
   type t = Jsonrpc.Id.t
 
@@ -20,7 +22,7 @@ module Req_id = struct
     | `Int i -> string_of_int i
 end
 
-(** {2 Server interface for some IO substrate} *)
+(** Server interface for some IO substrate. *)
 module Make (IO : IO) = struct
   open Lsp.Types
   module Position = Position