docs(Learnocaml_api): Fix other details in ocamldoc comments

ocaml-sf · Sep 30, 2021 · 2c1347c · 2c1347c
1 parent 64722ed
commit 2c1347c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/src/state/learnocaml_api.ml b/src/state/learnocaml_api.ml
@@ -16,7 +16,7 @@ module type COMPAT = sig
 
   val to_string : t -> string
 
-  (** Supported formats: [Compat.v "str"] where "str" is
+  (** Supported formats: [Compat.v "str"] where "str" is nonempty and
       either "n", "-n" (a signed integer), or "n.str".
       However, [Compat.v "0.14.rc1"] or so is not supported for now. *)
   val v : string -> t

diff --git a/src/state/learnocaml_api.mli b/src/state/learnocaml_api.mli
@@ -29,7 +29,7 @@ module type COMPAT = sig
 
   val to_string : t -> string
 
-  (** Supported formats: [Compat.v "str"] where "str" is
+  (** Supported formats: [Compat.v "str"] where "str" is nonempty and
       either "n", "-n" (a signed integer), or "n.str".
       However, [Compat.v "0.14.rc1"] or so is not supported for now. *)
   val v : string -> t
@@ -147,7 +147,7 @@ type _ request =
 val supported_versions: 'a request -> Compat.pred
 
 (** [is supported client server req] = Ok () if
-    [server <= client && current "supports" req && server "supports" client] *)
+    [server <= client && "client supports req" && "server supports req"] *)
 val is_supported:
   ?current:Compat.t -> server:Compat.t ->
   'resp request -> (unit, string) result