Update ocamlformat

samoht · samoht · commit a9672bb8e897 · 2024-12-06T13:33:45.000+01:00
diff --git a/.ocamlformat b/.ocamlformat
@@ -1,3 +1,3 @@
-version=0.26.1
+version=0.27.0
 profile=conventional
 ocaml-version=4.08.0
diff --git a/bin/cli.mli b/bin/cli.mli
@@ -18,9 +18,8 @@ val force_output : [> `Force_output of bool ] t
 type output = File of string | Stdout
 
 val output : [> `Output of output option ] t
-(** A --output option to overwrite the command output.
-    One can pass it ["-"] to set it to stdout which should imply [force_output].
-    [default_doc] is used to describe the default value in the command's
-    manpage *)
+(** A --output option to overwrite the command output. One can pass it ["-"] to
+    set it to stdout which should imply [force_output]. [default_doc] is used to
+    describe the default value in the command's manpage *)
 
 val setup : [> `Setup of unit ] t
diff --git a/lib/block.mli b/lib/block.mli
@@ -45,8 +45,8 @@ type toplevel_value = {
 
 type include_ocaml_file = {
   part_included : string option;
-      (** [part_included] is the part of the file to synchronize with.
-          If lines is not specified synchronize the whole file. *)
+      (** [part_included] is the part of the file to synchronize with. If lines
+          is not specified synchronize the whole file. *)
 }
 
 type include_other_file = { header : Header.t option }
@@ -100,7 +100,8 @@ type t = {
   contents : string list;
   skip : bool;
   version_enabled : bool;
-      (** Whether the current OCaml version complies with the block's version. *)
+      (** Whether the current OCaml version complies with the block's version.
+      *)
   os_type_enabled : bool;
       (** Whether the current os type complies with the block's version. *)
   set_variables : (string * string) list;
@@ -126,8 +127,8 @@ val mk_include :
   section:section option ->
   labels:Label.t list ->
   (t, [ `Msg of string ]) result
-(** [mk_include] builds an include block from a comment [<!-- $MDX ... -->]
-    that is not followed by a code block [``` ... ```]. *)
+(** [mk_include] builds an include block from a comment [<!-- $MDX ... -->] that
+    is not followed by a code block [``` ... ```]. *)
 
 val from_raw : Raw.t -> (t, [ `Msg of string ] list) Result.result
 
@@ -160,7 +161,8 @@ val file : t -> string option
 (** [file t] is the name of the file to synchronize [t] with. *)
 
 val set_variables : t -> (string * string) list
-(** [set_variable t] is the list of environment variable to set and their values *)
+(** [set_variable t] is the list of environment variable to set and their values
+*)
 
 val unset_variables : t -> string list
 (** [unset_variable t] is the list of environment variable to unset *)
diff --git a/lib/cram.mli b/lib/cram.mli
@@ -36,9 +36,8 @@ val use_heredoc : t -> bool
 (** [use_heredoc t] is true iff [t] uses the heredoc ['<<'] syntax. *)
 
 val command_line : t -> string
-(** [command_line t] is [t]'s command line. It either adds ['\'] at
-   the end of each line of [t]'s command or do nothing is [t] uses the
-   heredoc syntax. *)
+(** [command_line t] is [t]'s command line. It either adds ['\'] at the end of
+    each line of [t]'s command or do nothing is [t] uses the heredoc syntax. *)
 
 (** {2 Parser} *)
 
@@ -48,12 +47,12 @@ val of_lines : string list -> cram_tests
 (** {2 Pretty-printer} *)
 
 val pp : ?pad:int -> t Fmt.t
-(** [pp] is the pretty-printer for cram tests. [pad] is the size of
-   the optional whitespace left padding (by default it is 0). *)
+(** [pp] is the pretty-printer for cram tests. [pad] is the size of the optional
+    whitespace left padding (by default it is 0). *)
 
 val pp_vertical_pad : int Fmt.t
 (** [pp_vertical_pad] is the pretty printer for the initial padding on the top
-   of Cram tests *)
+    of Cram tests *)
 
 val dump : t Fmt.t
 (** [dump] it the printer for dumping cram tests. Useful for debugging. *)
diff --git a/lib/document.mli b/lib/document.mli
@@ -28,8 +28,8 @@ type t = line list
 (** The type for mdx documents. *)
 
 val pp : ?syntax:Syntax.t -> t Fmt.t
-(** [pp] is the pretty printer for mdx documents. Should be idempotent
-   with {!of_string}. *)
+(** [pp] is the pretty printer for mdx documents. Should be idempotent with
+    {!of_string}. *)
 
 val dump : t Fmt.t
 (** [dump] is the printer for dumping mdx documents. Useful for debugging. *)
diff --git a/lib/label.mli b/lib/label.mli
@@ -21,8 +21,8 @@ module Relation : sig
   val compare : t -> int -> int -> bool
 
   val raw_parse : string -> string * (t * string) option
-  (** [raw_parse s] splits [s] into a label, and optionally the relation and
-      the associated value. *)
+  (** [raw_parse s] splits [s] into a label, and optionally the relation and the
+      associated value. *)
 end
 
 type non_det = Nd_output | Nd_command
diff --git a/lib/library.mli b/lib/library.mli
@@ -16,9 +16,8 @@
 
 type t = { base_name : string; sub_lib : string option }
 (** The type to represent dune libraries as referred to in '#require' statements
-    or in dune files.
-    I.e. lib.sub_lib is [{base_name = "lib"; sub_lib = Some "sub_lib"}].
-    *)
+    or in dune files. I.e. lib.sub_lib is
+    [{base_name = "lib"; sub_lib = Some "sub_lib"}]. *)
 
 val equal : t -> t -> bool
 val compare : t -> t -> int
@@ -34,6 +33,6 @@ module Set : sig
 
   val to_package_set : t -> Astring.String.Set.t
   (** [to_package_set lib_set] returns the set of dune packages needed to get
-      all the libraries in [lib_set].
-      I.e. it's the set of basenames for all the libraries in [lib_set]. *)
+      all the libraries in [lib_set]. I.e. it's the set of basenames for all the
+      libraries in [lib_set]. *)
 end
diff --git a/lib/mdx.mli b/lib/mdx.mli
@@ -16,12 +16,12 @@
 
 (** [Mdx] is a library to manipulate markdown code blocks.
 
-    [mdx] allows to execute code blocks inside markdown files. The
-   supported code {{!Block}blocks} are either {{!Cram}cram-like}
-   tests, raw OCaml fragments or {{!Toplevel}toplevel} phrases.
+    [mdx] allows to execute code blocks inside markdown files. The supported
+    code {{!Block}blocks} are either {{!Cram}cram-like} tests, raw OCaml
+    fragments or {{!Toplevel}toplevel} phrases.
 
     Cram tests and toplevel phrases are sequences of commands and
-   {{!Output}outputs}.  *)
+    {{!Output}outputs}. *)
 
 module Lexer_mdx = Lexer_mdx
 module Output = Output
@@ -61,8 +61,8 @@ val run_to_stdout :
   string ->
   (unit, [ `Msg of string ] list) result
 (** [run_to_stdout ?syntax ~f file] runs the callback [f] on the raw and
-    structured content of [file], as specified  by [syntax] (defaults to [Markdown]).
-    The returned corrected version is then written to stdout. *)
+    structured content of [file], as specified by [syntax] (defaults to
+    [Markdown]). The returned corrected version is then written to stdout. *)
 
 val run_to_file :
   ?syntax:Syntax.t ->
@@ -90,5 +90,5 @@ val section_of_line : line -> (int * string) option
 (** [section_of_line l] is [l]'s section. *)
 
 val filter_section : Re.re -> t -> t option
-(** [section re t] is the subset of [t] such that their section
-   matches with [re]. *)
+(** [section re t] is the subset of [t] such that their section matches with
+    [re]. *)
diff --git a/lib/mli_parser.ml b/lib/mli_parser.ml
@@ -104,7 +104,10 @@ let docstring_code_blocks str =
             let loc = Docstrings.docstring_loc docstring in
 
             (* odoc-parser adjusts for the initial [** *)
-            let adjustment = 3 (* String.length "(**" *) in
+            let adjustment =
+              3
+              (* String.length "(**" *)
+            in
 
             let location =
               {
diff --git a/lib/output.ml b/lib/output.ml
@@ -48,7 +48,8 @@ let equal a b =
     | (`Ellipsis :: a as x), (_ :: b as y)
     | (_ :: b as y), (`Ellipsis :: a as x) ->
         aux x b
-        || (* n+ matches: skip y's head *)
+        ||
+        (* n+ matches: skip y's head *)
         aux a y
         (* 0  match  : skip x's head *)
     | a :: b, h :: t -> (a = h || ellipsis_equal (a, h)) && aux b t
diff --git a/lib/output.mli b/lib/output.mli
@@ -17,20 +17,19 @@
 (** Test outputs. *)
 
 type t = [ `Output of string | `Ellipsis ]
-(** The type for test outputs. Ellipisis ([...]) allow to skip zero,
-   one or many lines while comparing the outputs with {!equal}. *)
+(** The type for test outputs. Ellipisis ([...]) allow to skip zero, one or many
+    lines while comparing the outputs with {!equal}. *)
 
 val equal : t list -> t list -> bool
-(** [equal x y] is true iff [x] and [y] are equivalent, modulo
-   ellipsis. *)
+(** [equal x y] is true iff [x] and [y] are equivalent, modulo ellipsis. *)
 
 val merge : [ `Output of string ] list -> t list -> t list
-(** [merge output test] merges any [`Ellipsis] items from [test] into
-   [output]. *)
+(** [merge output test] merges any [`Ellipsis] items from [test] into [output].
+*)
 
 val pp : ?pad:int -> t Fmt.t
-(** [pp] is the pretty-printer for test outputs. [pad] is the size of
-   the optional whitespace left-padding (by default it is 0). *)
+(** [pp] is the pretty-printer for test outputs. [pad] is the size of the
+    optional whitespace left-padding (by default it is 0). *)
 
 val dump : t Fmt.t
 (** [dump] is the printer for dumping test outputs. Useful for debugging. *)
diff --git a/lib/part.mli b/lib/part.mli
@@ -18,20 +18,20 @@ type file
 (** The type for files. *)
 
 val read : string -> file
-(** [read f] is the file [f]. It's a costly operations, better to be
-   done once. *)
+(** [read f] is the file [f]. It's a costly operations, better to be done once.
+*)
 
 val contents : file -> string
 (** [contents f] is [f] contents. *)
 
 val find : file -> part:string option -> string list option
-(** [find f ~part] returns the lines of the part [part] in the file
-   [f]. Return [None] if [f] does not contain the part [part]. *)
+(** [find f ~part] returns the lines of the part [part] in the file [f]. Return
+    [None] if [f] does not contain the part [part]. *)
 
 val replace : file -> part:string option -> lines:string list -> file
-(** [replace ~file ~part ~lines] returns the lines of the file [file] where
-    the lines of part [part] have been replaced by [lines].
-    If [part] does not occur in the file, a new part is added at the end. *)
+(** [replace ~file ~part ~lines] returns the lines of the file [file] where the
+    lines of part [part] have been replaced by [lines]. If [part] does not occur
+    in the file, a new part is added at the end. *)
 
 (**/**)
 
diff --git a/lib/prelude.mli b/lib/prelude.mli
@@ -19,8 +19,8 @@ type t = [ `All | `One of Ocaml_env.t ] * string
 val pp : t Fmt.t
 
 val env_and_payload : string -> t
-(** [env_and_payload s] returns the environment and file/prelude string described
-    by [s].
-    I.e. [env_and_payload "a:f"] associates [f] to the environment named [a],
-    [env_and_payload " :f"] associates [f] to the default environment, and
-    [env_and_payload "f"] associates [f] to all environments. *)
+(** [env_and_payload s] returns the environment and file/prelude string
+    described by [s]. I.e. [env_and_payload "a:f"] associates [f] to the
+    environment named [a], [env_and_payload " :f"] associates [f] to the default
+    environment, and [env_and_payload "f"] associates [f] to all environments.
+*)
diff --git a/lib/stable_printer.mli b/lib/stable_printer.mli
@@ -1,8 +1,9 @@
-(** Stable printing functions built on top of compiler-libs types
-Use this for user facing part of the code so that mdx's output does not
-depend on the ocaml version it was built with. *)
+(** Stable printing functions built on top of compiler-libs types Use this for
+    user facing part of the code so that mdx's output does not depend on the
+    ocaml version it was built with. *)
 
 module Location : sig
   val pp : Format.formatter -> Location.t -> unit
-  (** Prints location for error reporting as ["File <file>, lines <line-range>"] *)
+  (** Prints location for error reporting as ["File <file>, lines <line-range>"]
+  *)
 end
diff --git a/lib/top/mdx_top.ml b/lib/top/mdx_top.ml
@@ -140,7 +140,7 @@ module Phrase = struct
     match parse lines with exception End_of_file -> None | t -> Some t
 
   (** Returns the name of the toplevel directive or [None] if the given phrase
-    is not a directive *)
+      is not a directive *)
   let top_directive_name (toplevel_phrase : Parsetree.toplevel_phrase) =
     match toplevel_phrase with
     | Ptop_def _ -> None
diff --git a/lib/top/mdx_top.mli b/lib/top/mdx_top.mli
@@ -36,7 +36,7 @@ val init :
 (** [init ()] is a new configuration value. *)
 
 val eval : t -> string list -> (string list, string list) result
-(** [eval t p] evaluates the toplevel phrase [p] (possibly spawning on
-    mulitple lines) with the configuration value [t]. *)
+(** [eval t p] evaluates the toplevel phrase [p] (possibly spawning on mulitple
+    lines) with the configuration value [t]. *)
 
 val in_env : Mdx.Ocaml_env.t -> (unit -> 'a) -> 'a
diff --git a/lib/toplevel.mli b/lib/toplevel.mli
@@ -30,15 +30,13 @@ type toplevel_tests = { tests : t list; end_pad : string option }
 (** {2 Pretty-printing} *)
 
 val dump : t Fmt.t
-(** [dump] is the printer for dumping toplevel phrases. Useful for
-   debugging. *)
+(** [dump] is the printer for dumping toplevel phrases. Useful for debugging. *)
 
 val dump_toplevel_tests : toplevel_tests Fmt.t
 
 val pp : t Fmt.t
-(** [pp] is the pretty-printer for top-level phrases. [pad] is the
-   size of the optionnalwhitespace left padding (by default is is
-   0). *)
+(** [pp] is the pretty-printer for top-level phrases. [pad] is the size of the
+    optionnalwhitespace left padding (by default is is 0). *)
 
 val pp_command : t Fmt.t
 (** [pp_command] is the pretty-printer for toplevel commands. *)
diff --git a/lib/util.mli b/lib/util.mli
@@ -82,9 +82,8 @@ end
 
 module Process : sig
   val wait : pid:int -> int
-  (** Wait for the given process and return an exit code.
-      Exit code is the same as the child process if it exits normally, or 255
-      otherwise. *)
+  (** Wait for the given process and return an exit code. Exit code is the same
+      as the child process if it exits normally, or 255 otherwise. *)
 end
 
 module Int : sig
diff --git a/test/bin/mdx-pp/gen_dune_rules.ml b/test/bin/mdx-pp/gen_dune_rules.ml
@@ -10,9 +10,9 @@ let pp_expect_action fmt dir =
     (run ocaml-mdx pp %a%s)))|}
     dir.dir_name pp_options dir.options dir.test_file
 
-(** Tests that 'cd <dir> && ocaml-mdx pp [options] <file>' exits with a
-    failing code and that its output is equal to the content of the
-    '.expected' file in <dir>. *)
+(** Tests that 'cd <dir> && ocaml-mdx pp [options] <file>' exits with a failing
+    code and that its output is equal to the content of the '.expected' file in
+    <dir>. *)
 let pp_failure_action fmt dir =
   Fmt.pf fmt
     {|
diff --git a/test/bin/mdx-test/gen_dune_rules.ml b/test/bin/mdx-test/gen_dune_rules.ml
@@ -15,9 +15,9 @@
  *)
 open Gen_rule_helpers
 
-(** Tests that the result of 'cd <dir_name> && ocaml-mdx test [options] test-case.md'
-    is equal to '<dir_name>/test-case.md.expected' if it exists or to
-    '<dir>/test-case.md' otherwise. *)
+(** Tests that the result of 'cd <dir_name> && ocaml-mdx test [options]
+    test-case.md' is equal to '<dir_name>/test-case.md.expected' if it exists or
+    to '<dir>/test-case.md' otherwise. *)
 let pp_expect_action fmt dir =
   Fmt.pf fmt
     {|
@@ -27,8 +27,8 @@ let pp_expect_action fmt dir =
     dir.dir_name pp_options dir.options dir.test_file
 
 (** Tests that 'cd <dir> && ocaml-mdx test [options] <file>' exits with a
-    failing code and that its output is equal to the content of the
-    '.expected' file in <dir>. *)
+    failing code and that its output is equal to the content of the '.expected'
+    file in <dir>. *)
 let pp_failure_action fmt dir =
   Fmt.pf fmt
     {|
diff --git a/test/lib/test_label.ml b/test/lib/test_label.ml
@@ -53,8 +53,8 @@ let test_interpret =
       ~expected:
         (Error
            (`Msg
-             "\"bar\" is not a valid value for label `non-deterministic`. \
-              Valid values are <none>, \"command\" and \"output\"."));
+              "\"bar\" is not a valid value for label `non-deterministic`. \
+               Valid values are <none>, \"command\" and \"output\"."));
     make_test ~label:"dir"
       ~value:(Some (Lt, "bar"))
       ~expected:
diff --git a/test/lib/test_part.ml b/test/lib/test_part.ml
@@ -41,8 +41,8 @@ let test_of_line =
       ~expected:
         (Error
            (`Msg
-             "'part-end' delimiter does not accept a value. Please write '(* \
-              $MDX part-end *)' instead."));
+              "'part-end' delimiter does not accept a value. Please write '(* \
+               $MDX part-end *)' instead."));
   ]
 
 let suite = ("Parts", test_of_line)
