Skip to content

Commit 3e78a38

Browse files
committed
Add explanatory comment
1 parent ac64e51 commit 3e78a38

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/odoc/odoc_link.ml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ let from_odoc ~resolver ~warnings_options input output =
4545
link_unit ~resolver ~filename m
4646
|> handle_warnings ~input_warnings ~warnings_options
4747
>>= fun (m, warnings) ->
48+
(* Remove the shape here so that we only depend upon odoc types
49+
rather than odoc and ocaml types. This means we should be able
50+
save an odocl file with odoc x.y compiled with one version of
51+
the compiler and load it in odoc x.y compiled with a different
52+
version of the compiler. This is an important use case for
53+
voodoo. *)
4854
let m = { m with Odoc_model.Lang.Compilation_unit.shape = None } in
4955
Odoc_file.save_unit output ~warnings m;
5056
Ok (`Module m)

0 commit comments

Comments
 (0)