+2 -1

src/odoc/asset.ml

··· 1 1 - open Or_error 1 1 + open Odoc_utils 2 2 + open ResultMonad 2 3 3 4 let compile ~parent_id ~name ~output_dir = 4 5 let open Odoc_model in

+1 -1

src/odoc/asset.mli

··· 1 1 - open Or_error 1 1 + open Odoc_utils 2 2 3 3 val compile : 4 4 parent_id:string ->

+1 -11

src/odoc/bin/main.ml

··· 4 4 output the result to. *) 5 5 6 6 open Odoc_utils 7 7 + open ResultMonad 7 8 module List = ListLabels 8 9 open Odoc_odoc 9 10 open Cmdliner ··· 225 226 let compile hidden directories resolve_fwd_refs dst output_dir package_opt 226 227 parent_name_opt parent_id_opt open_modules children input warnings_options 227 228 unique_id short_title = 228 228 - let open Or_error in 229 229 let _ = 230 230 match unique_id with 231 231 | Some id -> Odoc_model.Names.set_unique_ident id ··· 476 476 end 477 477 478 478 module Indexing = struct 479 479 - open Or_error 480 480 - 481 479 let output_file ~dst marshall = 482 480 match (dst, marshall) with 483 481 | Some file, `JSON ··· 578 576 end 579 577 580 578 module Sidebar = struct 581 581 - open Or_error 582 582 - 583 579 let output_file ~dst marshall = 584 580 match (dst, marshall) with 585 581 | Some file, `JSON when not (Fpath.has_ext "json" (Fpath.v file)) -> ··· 669 665 | Some file -> Fs.File.of_string file 670 666 | None -> Fs.File.(set_ext ".odocl" input) 671 667 672 672 - open Or_error 673 673 - 674 668 (** Find the package/library name the output is part of *) 675 669 let find_root_of_input l o = 676 670 let l = ··· 1475 1469 | Some p -> Format.fprintf pp "%a/" fmt_page p 1476 1470 1477 1471 let list_dependencies input_file = 1478 1478 - let open Or_error in 1479 1472 Depends.for_rendering_step (Fs.Directory.of_string input_file) 1480 1473 >>= fun depends -> 1481 1474 List.iter depends ~f:(fun (root : Odoc_model.Root.t) -> ··· 1559 1552 end 1560 1553 1561 1554 module Occurrences = struct 1562 1562 - open Or_error 1563 1563 - 1564 1555 let dst_of_string s = 1565 1556 let f = Fs.File.of_string s in 1566 1557 if not (Fs.File.has_ext ".odoc-occurrences" f) then ··· 1652 1643 module Odoc_error = struct 1653 1644 let errors input = 1654 1645 let open Odoc_odoc in 1655 1655 - let open Or_error in 1656 1646 let input = Fs.File.of_string input in 1657 1647 Odoc_file.load input >>= fun unit -> 1658 1648 Odoc_model.Error.print_errors unit.warnings;

+2 -2

src/odoc/compile.ml

··· 1 1 + open Odoc_utils 2 2 + open ResultMonad 1 3 open Odoc_model 2 4 open Odoc_model.Names 3 3 - open Or_error 4 4 - open Odoc_utils 5 5 6 6 (* 7 7 * Copyright (c) 2014 Leo White <leo@lpw25.net>

+1 -1

src/odoc/compile.mli

··· 14 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 15 *) 16 16 17 17 + open Odoc_utils 17 18 open Odoc_model 18 19 open Odoc_model.Paths 19 19 - open Or_error 20 20 21 21 type package_spec = { package : string; output : Fpath.t } 22 22 type parent_spec = {

+2 -1

src/odoc/depends.ml

··· 14 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 15 *) 16 16 17 17 + open Odoc_utils 18 18 + open ResultMonad 17 19 open StdLabels 18 18 - open Or_error 19 20 20 21 module Odoc_compile = Compile 21 22

+1 -1

src/odoc/depends.mli

··· 14 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 15 *) 16 16 17 17 - open Or_error 17 17 + open Odoc_utils 18 18 19 19 (** Computes the dependencies required for each step of the pipeline to work 20 20 correctly on a given input. *)

-1

src/odoc/fs.ml

··· 16 16 17 17 open Odoc_utils 18 18 open StdLabels 19 19 - open Or_error 20 19 21 20 type directory = Fpath.t 22 21

+1 -3

src/odoc/fs.mli

··· 1 1 - open Or_error 1 1 + open Odoc_utils 2 2 3 3 (* 4 4 * Copyright (c) 2016 Thomas Refis <trefis@janestreet.com> ··· 23 23 type directory 24 24 25 25 module Directory : sig 26 26 - open Or_error 27 27 - 28 26 type t = directory 29 27 30 28 val dirname : t -> t

+1 -1

src/odoc/html_fragment.ml

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

+1 -1

src/odoc/html_fragment.mli

··· 14 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 15 *) 16 16 17 17 - open Or_error 17 17 + open Odoc_utils 18 18 19 19 (** Produces html fragment files from a mld file. *) 20 20

+1 -2

src/odoc/indexing.ml

··· 1 1 open Odoc_utils 2 2 - open Astring 2 2 + open ResultMonad 3 3 open Odoc_json_index 4 4 - open Or_error 5 4 open Odoc_model 6 5 7 6 module H = Odoc_model.Paths.Identifier.Hashtbl.Any

+1 -1

src/odoc/indexing.mli

··· 1 1 - open Or_error 1 1 + open Odoc_utils 2 2 3 3 val compile : 4 4 [ `JSON | `Marshall ] ->

+1 -4

src/odoc/occurrences.ml

··· 1 1 open Odoc_utils 2 2 - open Or_error 2 2 + open ResultMonad 3 3 4 4 let handle_file file ~f = 5 5 if String.is_prefix ~affix:"impl-" (Fpath.filename file) then ··· 33 33 Fs.Directory.mkdir_p (Fs.File.dirname dst); 34 34 Io_utils.marshal (Fs.File.to_string dst) htbl; 35 35 Ok () 36 36 - 37 37 - open Astring 38 38 - open Or_error 39 36 40 37 let parse_input_file input = 41 38 let is_sep = function '\n' | '\r' -> true | _ -> false in

+1 -1

src/odoc/odoc_file.ml

··· 15 15 *) 16 16 17 17 open Odoc_utils 18 18 + open ResultMonad 18 19 open Odoc_model 19 19 - open Or_error 20 20 21 21 type unit_content = Lang.Compilation_unit.t 22 22

+1 -1

src/odoc/odoc_file.mli

··· 16 16 17 17 (** Load and save [.odoc] and [.odocl] files. *) 18 18 19 19 + open Odoc_utils 19 20 open Odoc_model 20 20 - open Or_error 21 21 22 22 (** Either a page or a module or something else. *) 23 23 type content =

+2 -1

src/odoc/odoc_link.ml

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

-7

src/odoc/or_error.ml

··· 1 1 - type msg = [ `Msg of string ] 2 2 - 3 3 - let ( >>= ) = Result.bind 4 4 - 5 5 - let rec fold_list f acc = function 6 6 - | [] -> Ok acc 7 7 - | hd :: tl -> f acc hd >>= fun acc -> fold_list f acc tl

-6

src/odoc/or_error.mli

··· 1 1 - type msg = [ `Msg of string ] 2 2 - 3 3 - val ( >>= ) : ('a, 'e) result -> ('a -> ('b, 'e) result) -> ('b, 'e) result 4 4 - 5 5 - val fold_list : 6 6 - ('acc -> 'a -> ('acc, 'e) result) -> 'acc -> 'a list -> ('acc, 'e) result

+1 -1

src/odoc/rendering.ml

··· 1 1 open Odoc_utils 2 2 + open ResultMonad 2 3 open Odoc_document 3 3 - open Or_error 4 4 open Odoc_model 5 5 6 6 let prepare ~extra_suffix ~output_dir filename =

+3 -3

src/odoc/rendering.mli

··· 1 1 + open Odoc_utils 1 2 open Odoc_document 2 2 - open Or_error 3 3 4 4 val render_odoc : 5 5 resolver:Resolver.t -> ··· 42 42 extra_suffix:string option -> 43 43 'a -> 44 44 Fs.file -> 45 45 - (unit, [> Or_error.msg ]) result 45 45 + (unit, [> msg ]) result 46 46 47 47 val targets_odoc : 48 48 resolver:Resolver.t -> ··· 62 62 extra:'a -> 63 63 source_file:Fpath.t -> 64 64 Fs.file -> 65 65 - (unit, [> Or_error.msg ]) result 65 65 + (unit, [> msg ]) result

+1 -1

src/odoc/resolver.ml

··· 32 32 which will generally fix this issue. *) 33 33 34 34 open Odoc_utils 35 35 - open Or_error 35 35 + open ResultMonad 36 36 37 37 type named_root = string * Fs.Directory.t 38 38 module Named_roots : sig

+1 -1

src/odoc/sidebar.ml

··· 1 1 - open Or_error 2 1 open Odoc_utils 2 2 + open ResultMonad 3 3 4 4 let compile_to_json ~output sidebar = 5 5 let json = Odoc_html.Sidebar.to_json sidebar in

+2 -1

src/odoc/source.ml

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

+2

src/utils/odoc_utils.ml

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

+2 -1

test/odoc_print/odoc_print.ml

··· 1 1 (** Print .odocl files. *) 2 2 3 3 + open Odoc_utils 4 4 + open ResultMonad 3 5 open Odoc_odoc 4 4 - open Odoc_odoc.Or_error 5 6 open Odoc_model_desc 6 7 7 8 let print_json_desc desc x =