Remove Or_error in favor of Odoc_utils

Author: Julow

src/odoc/asset.ml

@@ -1,4 +1,5 @@
-open Or_error
+open Odoc_utils
+open ResultMonad
 
 let compile ~parent_id ~name ~output_dir =
   let open Odoc_model in

src/odoc/asset.mli

@@ -1,4 +1,4 @@
-open Or_error
+open Odoc_utils
 
 val compile :
   parent_id:string ->

src/odoc/bin/main.ml

@@ -4,6 +4,7 @@
    output the result to. *)
 
 open Odoc_utils
+open ResultMonad
 module List = ListLabels
 open Odoc_odoc
 open Cmdliner
@@ -225,7 +226,6 @@ end = struct
   let compile hidden directories resolve_fwd_refs dst output_dir package_opt
       parent_name_opt parent_id_opt open_modules children input warnings_options
       unique_id short_title =
-    let open Or_error in
     let _ =
       match unique_id with
       | Some id -> Odoc_model.Names.set_unique_ident id
@@ -476,8 +476,6 @@ module Compile_impl = struct
 end
 
 module Indexing = struct
-  open Or_error
-
   let output_file ~dst marshall =
     match (dst, marshall) with
     | Some file, `JSON
@@ -578,8 +576,6 @@ module Indexing = struct
 end
 
 module Sidebar = struct
-  open Or_error
-
   let output_file ~dst marshall =
     match (dst, marshall) with
     | Some file, `JSON when not (Fpath.has_ext "json" (Fpath.v file)) ->
@@ -669,8 +665,6 @@ end = struct
     | Some file -> Fs.File.of_string file
     | None -> Fs.File.(set_ext ".odocl" input)
 
-  open Or_error
-
   (** Find the package/library name the output is part of *)
   let find_root_of_input l o =
     let l =
@@ -1475,7 +1469,6 @@ module Depends = struct
       | Some p -> Format.fprintf pp "%a/" fmt_page p
 
     let list_dependencies input_file =
-      let open Or_error in
       Depends.for_rendering_step (Fs.Directory.of_string input_file)
       >>= fun depends ->
       List.iter depends ~f:(fun (root : Odoc_model.Root.t) ->
@@ -1559,8 +1552,6 @@ module Targets = struct
 end
 
 module Occurrences = struct
-  open Or_error
-
   let dst_of_string s =
     let f = Fs.File.of_string s in
     if not (Fs.File.has_ext ".odoc-occurrences" f) then
@@ -1652,7 +1643,6 @@ end
 module Odoc_error = struct
   let errors input =
     let open Odoc_odoc in
-    let open Or_error in
     let input = Fs.File.of_string input in
     Odoc_file.load input >>= fun unit ->
     Odoc_model.Error.print_errors unit.warnings;

src/odoc/compile.ml

@@ -1,7 +1,7 @@
+open Odoc_utils
+open ResultMonad
 open Odoc_model
 open Odoc_model.Names
-open Or_error
-open Odoc_utils
 
 (*
  * Copyright (c) 2014 Leo White <[email protected]>

src/odoc/compile.mli

@@ -14,9 +14,9 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
+open Odoc_utils
 open Odoc_model
 open Odoc_model.Paths
-open Or_error
 
 type package_spec = { package : string; output : Fpath.t }
 type parent_spec = {

src/odoc/depends.ml

@@ -14,8 +14,9 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
+open Odoc_utils
+open ResultMonad
 open StdLabels
-open Or_error
 
 module Odoc_compile = Compile
 

src/odoc/depends.mli

@@ -14,7 +14,7 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
-open Or_error
+open Odoc_utils
 
 (** Computes the dependencies required for each step of the pipeline to work
     correctly on a given input. *)

src/odoc/fs.ml

@@ -16,7 +16,6 @@
 
 open Odoc_utils
 open StdLabels
-open Or_error
 
 type directory = Fpath.t
 

src/odoc/fs.mli

@@ -1,4 +1,4 @@
-open Or_error
+open Odoc_utils
 
 (*
  * Copyright (c) 2016 Thomas Refis <[email protected]>
@@ -23,8 +23,6 @@ type file = Fpath.t
 type directory
 
 module Directory : sig
-  open Or_error
-
   type t = directory
 
   val dirname : t -> t

src/odoc/html_fragment.ml

@@ -1,5 +1,5 @@
 open Odoc_utils
-open Or_error
+open ResultMonad
 
 let from_mld ~xref_base_uri ~resolver ~output ~warnings_options input =
   (* Internal names, they don't have effect on the output. *)

src/odoc/html_fragment.mli

@@ -14,7 +14,7 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
-open Or_error
+open Odoc_utils
 
 (** Produces html fragment files from a mld file. *)
 

src/odoc/indexing.ml

@@ -1,7 +1,6 @@
 open Odoc_utils
-open Astring
+open ResultMonad
 open Odoc_json_index
-open Or_error
 open Odoc_model
 
 module H = Odoc_model.Paths.Identifier.Hashtbl.Any

src/odoc/indexing.mli

@@ -1,4 +1,4 @@
-open Or_error
+open Odoc_utils
 
 val compile :
   [ `JSON | `Marshall ] ->

src/odoc/occurrences.ml

@@ -1,5 +1,5 @@
 open Odoc_utils
-open Or_error
+open ResultMonad
 
 let handle_file file ~f =
   if String.is_prefix ~affix:"impl-" (Fpath.filename file) then
@@ -34,9 +34,6 @@ let count ~dst ~warnings_options:_ directories include_hidden =
   Io_utils.marshal (Fs.File.to_string dst) htbl;
   Ok ()
 
-open Astring
-open Or_error
-
 let parse_input_file input =
   let is_sep = function '\n' | '\r' -> true | _ -> false in
   Fs.File.read input >>= fun content ->

src/odoc/odoc_file.ml

@@ -15,8 +15,8 @@
  *)
 
 open Odoc_utils
+open ResultMonad
 open Odoc_model
-open Or_error
 
 type unit_content = Lang.Compilation_unit.t
 

src/odoc/odoc_file.mli

@@ -16,8 +16,8 @@
 
 (** Load and save [.odoc] and [.odocl] files. *)
 
+open Odoc_utils
 open Odoc_model
-open Or_error
 
 (** Either a page or a module or something else. *)
 type content =

src/odoc/odoc_link.ml

@@ -1,4 +1,5 @@
-open Or_error
+open Odoc_utils
+open ResultMonad
 
 let link_page ~resolver ~filename page =
   let env = Resolver.build_env_for_page resolver page in

src/odoc/or_error.ml

@@ -1,6 +1,6 @@
 open Odoc_utils
+open ResultMonad
 open Odoc_document
-open Or_error
 open Odoc_model
 
 let prepare ~extra_suffix ~output_dir filename =

src/odoc/or_error.mli

@@ -1,5 +1,5 @@
+open Odoc_utils
 open Odoc_document
-open Or_error
 
 val render_odoc :
   resolver:Resolver.t ->
@@ -42,7 +42,7 @@ val generate_asset_odoc :
   extra_suffix:string option ->
   'a ->
   Fs.file ->
-  (unit, [> Or_error.msg ]) result
+  (unit, [> msg ]) result
 
 val targets_odoc :
   resolver:Resolver.t ->
@@ -62,4 +62,4 @@ val targets_source_odoc :
   extra:'a ->
   source_file:Fpath.t ->
   Fs.file ->
-  (unit, [> Or_error.msg ]) result
+  (unit, [> msg ]) result

src/odoc/rendering.ml

@@ -32,7 +32,7 @@
    which will generally fix this issue. *)
 
 open Odoc_utils
-open Or_error
+open ResultMonad
 
 type named_root = string * Fs.Directory.t
 module Named_roots : sig

src/odoc/rendering.mli

@@ -1,5 +1,5 @@
-open Or_error
 open Odoc_utils
+open ResultMonad
 
 let compile_to_json ~output sidebar =
   let json = Odoc_html.Sidebar.to_json sidebar in

src/odoc/resolver.ml

@@ -1,5 +1,6 @@
+open Odoc_utils
+open ResultMonad
 open Odoc_model
-open Or_error
 
 let resolve_and_substitute ~resolver ~make_root ~source_id input_file =
   let filename = Fs.File.to_string input_file in

src/odoc/sidebar.ml

@@ -1,3 +1,5 @@
+type msg = [ `Msg of string ]
+
 (** The [result] type and a bind operator. This module is meant to be opened. *)
 module ResultMonad = struct
   let map_error f = function Ok _ as ok -> ok | Error e -> Error (f e)

src/odoc/source.ml

@@ -1,7 +1,8 @@
 (** Print .odocl files. *)
 
+open Odoc_utils
+open ResultMonad
 open Odoc_odoc
-open Odoc_odoc.Or_error
 open Odoc_model_desc
 
 let print_json_desc desc x =